Ground (functions)

More functions: Script Reference

The ground functions are used for various tasks on ground maps. Due to the size of the namespace, it is split into subpages based on what each function does.

Entities

Main article: Ground (functions)/Entities

Name	Description
Hide	Hides an entity.
Unhide	Unhides an entity.
RemoveObject	Deletes an object from the ground map, identified by its instance name.
RemoveCharacter	Deletes a character from the ground map, identified by its instance name.
CreateCharacterFromCharData	Creates a ground character, given a dungeon character.
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.
SpawnerDoSpawn	Make the specified spawner run its spawn method.
SpawnerSetSpawn	Sets the character to the specified spawner

Entity Movement

Main article: Ground (functions)/Entity Movement

Ground (functions)/Entity Movement/Table

Animation

Main article: Ground (functions)/Animation

Name	Description
CharSetEmote	Make a character emote on the ground map.
CharSetDrawEffect	Sets the ground character's draw effect to become invisible, shaking, still, etc.
CharEndDrawEffect	Sets the ground character's draw effect to become invisible, shaking, still, etc.
CharGetAnimFallback	Gets the fallback animation for the character.
CharGetAnim	Gets a character's current animation as a string.
CharGetAnimPoint	Gets the chosen action point of the character at this specific frame.
CharSetAnim	Set a character's animation.
CharEndAnim	Stops a character's current animation, reverting them to default idle.
CharWaitAnim	Makes the character perform an animation and waits until it's over.
CharSetAction	Set a character's action.
CharWaitAction	Makes the character perform an action and waits until it's over.
ObjectSetAnim	Sets a ground object's animation. After it finishes, it will return to the default animation.
ObjectSetDefaultAnim	Sets a ground object's default animation.
ObjectWaitAnimFrame	Waits for the object to reach a specific frame before continuing.

Vfx

Main article: Ground (functions)/Vfx

Name	Description
PlayVFX	Plays a VFX using a finite emitter that generates BaseAnims.
PlayVFX	Plays a VFX that has a start position and an end position. It uses a finite emitter that generates BaseAnims.
PlayVFXAnim	Plays a VFX using just a BaseAnim
MoveScreen	Plays a screen-moving effect.

Misc

Main article: Ground (functions)/Misc

Name	Description
HandoutEXP	Gives a character a set amount of EXP. Also handles leveling up and learning new moves.
AddMapStatus	Adds a mapstatus to the ground map. Map statuses only have an aesthetic effect in ground maps.
RemoveMapStatus	Removes a map status from the ground map.
SetupLuaFunctions	Initializes any LuaFunctions found in the class. Automatically on lua initialization.

Tutorials and reference for modding cutscenes and dialogue in PMDO