View source for Ground (functions)/Entity

== Hide ==

Hides an entity. {{FuncUsage|nmspace=GROUND|nm=Hide|args=entityName}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=entityName
|type=String
|techt=System.String
|purp=The name of the entity to hide.
}}
|}

== Unhide ==
Unhides an entity. {{FuncUsage|nmspace=GROUND|nm=Unhide|args=entityName}}


=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=entityName
|type=String
|techt=System.String
|purp=The name of the entity to unhide.
}}
|}

== CreateObject ==


TODO: WIP. {{FuncUsage|nmspace=GROUND|nm=CreateObject|args=objType, instName, x, y, w, h}}


=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=objType
|type=(undocumented)
|techt=(undocumented)
|purp=The type of object to create.
}}
{{ArgRow
|name=instName
|type=(undocumented)
|techt=(undocumented)
|purp=The name to create the object with.
}}
{{ArgRow
|name=x
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
{{ArgRow
|name=y
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
{{ArgRow
|name=w
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
{{ArgRow
|name=h
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
|}


== CreateCharacter ==

TODO: WIP. {{FuncUsage|nmspace=GROUND|nm=|args=charType, instName, x, y, actionFunc, thinkFunc}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=objType
|type=(undocumented)
|techt=(undocumented)
|purp=The type of character to create.
}}
{{ArgRow
|name=instName
|type=(undocumented)
|techt=(undocumented)
|purp=The name to create the character with.
}}
{{ArgRow
|name=x
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
{{ArgRow
|name=y
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
{{ArgRow
|name=actionFunc
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
{{ArgRow
|name=thinkFunc
|type=(undocumented)
|techt=(undocumented)
|purp=(undocumented)
}}
|}

== RemoveObject ==

Deletes an object from the ground map, identified by its instance name. {{FuncUsage|nmspace=GROUND|nm=RemoveObject|args=instName}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=instName
|type=String
|techt=System.String
|purp=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. {{FuncUsage|nmspace=GROUND|nm=RemoveCharacter|args=instName}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=instName
|type=String
|techt=System.String
|purp=The instance name of the character.
}}
|}

=== Returns ===

Returns true if succeeded, false otherwise.

== CreateCharacterFromCharData ==

Creates a ground character, given a dungeon character. {{FuncUsage|nmspace=GROUND|nm=CreateCharacterFromCharData|args=instName, dunCh, x, y, dir}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=instName
|type=String
|techt=System.String
|purp=The instance name to give the character
}}
{{ArgRow
|name=dunCh
|type=Dungeon Character
|techt=RogueEssence.Dungeon.Character
|purp=Character data to create from
}}
{{ArgRow
|name=x
|type=Integer
|techt=System.Int32
|purp=X coordinate of the character
}}
{{ArgRow
|name=y
|type=Integer
|techt=System.Int32
|purp=Y coordinate of the character
}}
{{ArgRow
|name=dir
|type=
|techt=
|purp=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. {{FuncUsage|nmspace=GROUND|nm=SetPlayer|args=charData}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=charData
|type=Character Data
|techt=RogueEssence.Dungeon.CharData
|purp=The new character data to use for the player
}}
|}

== SpawnerDoSpawn ==

Make the specified spawner run its spawn method. {{FuncUsage|nmspace=GROUND|nm=SpawnerDoSpawn|args=spawner}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=spawner
|type=String
|techt=System.String
|purp=The name of the spawner to run the spawn method of.
}}
|}

=== Returns ===

The ground character spawned.

== SpawnerSetSpawn ==

Sets the character to the specified spawner. {{FuncUsage|nmspace=GROUND|nm=SpawnerSetSpawn|args=spawner, chara}}

=== Arguments ===
{| class="wikitable"
{{ArgHeader}}
{{ArgRow
|name=spawner
|type=
|techt=
|purp=The spawner to set the character to, by name
}}
{{ArgRow
|name=chara
|type=Character Data
|techt=RogueEssence.Dungeon.CharData
|purp=The character to spawn.
}}
|}