SpawnCharacterOptions
What spawnCharacter takes.
Properties
Section titled “Properties”| Property | Type | Default value | Description |
|---|---|---|---|
facing? |
number |
undefined |
Radians about y she faces, over her saved facing: the scene’s <CharacterSpawn>’s where left out. |
key? |
string |
"main" |
The saved-entity key her save keeps this character under: one per character a player switches between. |
position? |
Vector3 |
undefined |
Where she spawns, over her saved place: her seat’s spawn point where left out, or the saved place her save keeps under her key. |
props? |
CharacterSpawnProps |
undefined |
Props laid over the scene’s <CharacterSpawn>’s, such as another model, other abilities or other health: a knight, a mage or a rogue from one scene. Each plugin’s onCharacterSpawn reads them, and in a game played alone the scene’s <CharacterSpawn> draws her by them; a room’s pages draw each character by her avatar. |
restore? |
boolean |
true |
Whether her record under key restores onto it: false starts it fresh, as a roguelike’s new run does. |