Ground (functions)/Entity
Hide
Hides an entity. Argument order is GROUND:Hide(entityName).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| entityName | String | System.String
|
The name of the entity to hide. |
Unhide
Unhides an entity. Argument order is GROUND:Unhide(entityName).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| entityName | String | System.String
|
The name of the entity to unhide. |
CreateObject
TODO: WIP. Argument order is GROUND:CreateObject(objType, instName, x, y, w, h).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| objType | (undocumented) | (undocumented)
|
The type of object to create. |
| instName | (undocumented) | (undocumented)
|
The name to create the object with. |
| x | (undocumented) | (undocumented)
|
(undocumented) |
| y | (undocumented) | (undocumented)
|
(undocumented) |
| w | (undocumented) | (undocumented)
|
(undocumented) |
| h | (undocumented) | (undocumented)
|
(undocumented) |
CreateCharacter
TODO: WIP. Argument order is GROUND:(charType, instName, x, y, actionFunc, thinkFunc).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| objType | (undocumented) | (undocumented)
|
The type of character to create. |
| instName | (undocumented) | (undocumented)
|
The name to create the character with. |
| x | (undocumented) | (undocumented)
|
(undocumented) |
| y | (undocumented) | (undocumented)
|
(undocumented) |
| actionFunc | (undocumented) | (undocumented)
|
(undocumented) |
| thinkFunc | (undocumented) | (undocumented)
|
(undocumented) |
RemoveObject
Deletes an object from the ground map, identified by its instance name. Argument order is GROUND:RemoveObject(instName).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| instName | String | System.String
|
The instance name of the object. |
Returns
Returns true if succeeded, false otherwise.
RemoveCharacter
Deletes a character from the ground map, identified by its instance name. Argument order is GROUND:RemoveCharacter(instName).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| instName | String | System.String
|
The instance name of the character. |
Returns
Returns true if succeeded, false otherwise.
CreateCharacterFromCharData
Creates a ground character, given a dungeon character. Argument order is GROUND:CreateCharacterFromCharData(instName, dunCh, x, y, dir).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| instName | String | System.String
|
The instance name to give the character |
| dunCh | Dungeon Character | RogueEssence.Dungeon.Character
|
Character data to create from |
| x | Integer | System.Int32
|
X coordinate of the character |
| y | Integer | System.Int32
|
Y coordinate of the character |
| dir | |
Direction the character will face, defaults to Dir8.Down |
RefreshPlayer
Reloads the controllable player's character data to be the current team's leader.
SetPlayer
Sets the controllable player to use new character data. Argument order is GROUND:SetPlayer(charData).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| charData | Character Data | RogueEssence.Dungeon.CharData
|
The new character data to use for the player |
SpawnerDoSpawn
Make the specified spawner run its spawn method. Argument order is GROUND:SpawnerDoSpawn(spawner).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| spawner | String | System.String
|
The name of the spawner to run the spawn method of. |
Returns
The ground character spawned.
SpawnerSetSpawn
Sets the character to the specified spawner. Argument order is GROUND:SpawnerSetSpawn(spawner, chara).
Arguments
| Name | Type | Technical Type | Purpose |
|---|---|---|---|
| spawner | |
The spawner to set the character to, by name | |
| chara | Character Data | RogueEssence.Dungeon.CharData
|
The character to spawn. |
