CharacterRespawnPositionDictionary - jimdroberts/FishMMO GitHub Wiki

Description

CharacterRespawnPositionDictionary is a serializable dictionary for FishMMO that maps string keys to CharacterRespawnPositionDetails. It is used to store and retrieve respawn locations and orientations for characters, enabling flexible and organized management of multiple respawn points.


Basic Usage

Setup

  1. Create a new CharacterRespawnPositionDictionary instance.
  2. Add entries mapping string keys (e.g., character names or IDs) to CharacterRespawnPositionDetails instances.
  3. Use the dictionary to store and retrieve respawn data as needed.

Example

// Example 1: Adding respawn positions to the dictionary
CharacterRespawnPositionDictionary respawnDict = new CharacterRespawnPositionDictionary();
respawnDict["Player1"] = new CharacterRespawnPositionDetails { Position = new Vector3(0, 1, 0), Rotation = Quaternion.identity };
respawnDict["Player2"] = new CharacterRespawnPositionDetails { Position = new Vector3(10, 1, 0), Rotation = Quaternion.Euler(0, 90, 0) };

// Example 2: Retrieving a respawn position
CharacterRespawnPositionDetails details = respawnDict["Player1"];

Best Practices

  • Use descriptive string keys (such as character names or unique IDs) for clarity and maintainability.
  • Store all relevant respawn data in CharacterRespawnPositionDetails for each entry.
  • Document the intended use and structure of the dictionary for future reference.
⚠️ **GitHub.com Fallback** ⚠️