CharacterDetails - jimdroberts/FishMMO GitHub Wiki

Description

Serializable class containing details about a character for selection and display. Used to transfer character information for character selection screens and related UI.


API Access

Fields

  • public class CharacterDetails

    Serializable class containing details about a character for selection and display.

    • string CharacterName: Name of the character.
    • string SceneName: Name of the scene where the character is currently located.
    • int RaceTemplateID: Template ID representing the character's race.
    • (TODO: Add equipped items list when implemented.)

Basic Usage

Setup

  1. Use this class to store and transfer character details for selection and display purposes.
  2. Populate the fields with the relevant character data.

Example

// Example: Creating and using CharacterDetails
CharacterDetails details = new CharacterDetails {
    CharacterName = "Lira",
    SceneName = "CapitalCity",
    RaceTemplateID = 3
};
// Use details for character selection UI

Best Practices

  • Always ensure character details are up-to-date before displaying them to the user.
  • Extend the class to include additional information (e.g., equipped items) as needed.
  • Use serialization attributes if transferring over the network or saving to disk.
⚠️ **GitHub.com Fallback** ⚠️