API

Assembly: Spark.Races Interface: IRacesPlugin Implementation: RacesPlugin

Interface

public interface IRacesPlugin
{
    List<RaceEntry> GetAllRaces();
    RaceEntry GetRace(string raceId);
}

Methods

GetAllRaces

List<RaceEntry> GetAllRaces()

Returns all race entries in the database.

GetRace

RaceEntry GetRace(string raceId)

Returns the race with the given ID, or null if not found.

RaceEntry

Extends SparkDatabaseEntry. Defines a playable race.

Field	Type	Description
raceCharacters	List<RaceCharacter>	Character variants for this race

RaceCharacter

Represents a character variant within a race (e.g., "Human Male", "Human Female").

Field	Type	Description
icon	Sprite	Visual representation
displayName	string	Player-facing name
characterEntry	CharacterEntry	Character configuration

Save Data

RaceSaveData

Extends SaveDataEntry. Simple single-selection model.

Field	Type	Description
selectedRaceId	string	Currently selected race

Methods:

void SetSelectedRace(string raceId)
string GetSelectedRace()

Usage

var races = Spark.GetPlugin<IRacesPlugin>();
if (races != null)
{
    // List all races
    var allRaces = races.GetAllRaces();

    // Get a specific race
    RaceEntry human = races.GetRace("human");

    // Access character variants
    foreach (var variant in human.raceCharacters)
    {
        Debug.Log($"{variant.displayName}: {variant.characterEntry.DisplayName}");
    }
}