> For the complete documentation index, see [llms.txt](https://docs.sparkframework.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sparkframework.dev/documentation/developer-guide/plugins/races/api.md).

# API

**Assembly:** `Spark.Races` **Interface:** `IRacesPlugin` **Implementation:** `RacesPlugin`

## Interface

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

## Methods

### GetAllRaces

```csharp
List<RaceEntry> GetAllRaces()
```

Returns all race entries in the database.

### GetRace

```csharp
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:**

```csharp
void SetSelectedRace(string raceId)
string GetSelectedRace()
```

## Usage

```csharp
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}");
    }
}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.sparkframework.dev/documentation/developer-guide/plugins/races/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.