roster
Server
The roster is the list of playable species on the select screen. It is global for the server, not per resource. The plugin applies it to the game mode every three seconds. Read the roster guide first.
modkit.roster.add
modkit.roster.add(name, classPath [, diet])
| Parameter | Type | Description |
|---|---|---|
| name | string | display name. Adding an existing name updates the entry. |
| classPath | string | /Game/.../BP_Name.BP_Name_C. Split at the first dot into package and class. |
| diet | string | "carnivore", "herbivore" or "omnivore". Default and fallback is omnivore. |
Returns: nothing. The call only changes the list. It does not check that the class exists.
modkit.roster.add("Avaceratops",
"/Game/TheIsle/Core/Characters/Dinosaurs/Avaceratops/BP_Avaceratops.BP_Avaceratops_C",
"herbivore")modkit.roster.remove
modkit.roster.remove(name)
Hides a species. Works for base game species and for your own entries. The name is compared without case.
| Parameter | Type | Description |
|---|---|---|
| name | string | display name of the species |
Returns: nothing.
modkit.roster.remove("Troodon")modkit.roster.list
modkit.roster.list()
Returns: array with the names added through modkit.roster.add. Base game species are not included.
print("custom species: " .. table.concat(modkit.roster.list(), ", "))