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.

Entity

Subpage: Ground (functions)/Entity

Generic status changes for entities and characters, under the general umbrella of entities. Also includes ground map spawners.

Function	Description
Hide	Hides an entity.
Unhide	Unhides an entity.
CreateObject	(undocumented)
CreateCharacter	(undocumented)
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 Turning

Subpage: Ground (functions)/Entity Turning

Functions for entities turning and/or facing directions, primarily for characters.

Function	Description
CharTurnToChar	Makes a character turn to face another character instantly.
CharTurnToCharAnimated	Makes a character do an animated turn to face another character over the specified time.
EntTurn	Makes a ground entity turn to face a direction.
CharAnimateTurn	Makes a character do an animated turn to face a chosen direction over the specified time.
CharAnimateTurnTo	Makes a character do an animated turn to face a chosen direction over the specified time.

Entity Movement

Subpage: Ground (functions)/Entity Movement

Functions for entities moving, primarily for characters.

Function	Description
TeleportTo	Repositions the ground entity in a specified location.
MoveInDirection	Make ground character move in a direction.
MoveToPostition	Make ground character move to a position.
MoveToMarker	Make ground character move to a ground marker.
MoveObjectToPosition	Make ground object move to a position.
AnimateInDirection	Make a ground character move in a direction with custom animation
AnimateToPosition	Make a ground entity move to a position with custom animation

Entity Animation

Subpage: Ground (functions)/Entity Animation

Functions for the animation of entities, primarily for characters. Includes emotes.

Function	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	Ends the character's draw effect.
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.
ObjectSectAnim	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.

Screen Effects

Subpage: Ground (functions)/Screen Effects

Functions for effects that impact the screen, including screen moving.

Function	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.

Leveling

Subpage: Ground (functions)/Leveling

Functions that impact the level of teams and/or characters.

Function	Description
HandoutEXP	Gives a character a set amount of EXP. Also handles leveling up and learning new moves.
LevelUpChar	Levels up a character a certain amount of times all at once. Also handles learning new moves.

Map Status

Subpage: Ground (functions)/Map Status

Functions that change the map status.

Function	Description
AddMapStatuses	Adds a mapstatus to the ground map. Map statuses only have an aesthetic effect in ground maps.
RemoveMapStatuses	Removes a map status from the ground map.

Tutorials and reference for modding cutscenes and dialogue in PMDO