Helpers

The next pages include a list of all the following helper functions:

Name	Description
Add Augment	Adds an augment to a character.
Add Status Effect	Adds a status effect to a character.
Apply Knockback	Pushes a character back and temporarily stuns them.
Get Active Party Member	Gets the identifier of a currently active party member by their index.
Get Action Status Effects	Gets an action's status effects.
Get Augment Duration	Gets an augment's duration.
Get Battle Unit Keep	Gets the battle unit keep address of a character.
Get Battle Unit Keep By Focus	Gets the battle unit keep address of a character.
Get Battle Unit Work	Gets the battle unit work address of a character.
Get Character Max Hp	Gets a character's max hp based on their status effects (disease, bubble).
Get Character Max Mp	Gets a character's max mp based on their augments (emptiness).
Get Character Type	Gets the type of a character.
Get Elemental Affinities Match	Checks if 2 elemental affinities have at least one match.
Get Equipment Status Effects	Gets the status effects of a character's weapon or off-hand.
Get Forced Poach Rarity	Gets the forced poach rarity from the debug settings.
Get Forced Steal Rarity	Gets the forced steal rarity from the debug settings.
Get Formula Proc Keep	Gets the formula processing keep address of a character.
Get Knockback Range	Gets a character's knockback range.
Get Location Mist Strength	Gets the current location's mist strength.
Get Model Evade Types	Gets all possible evade types of a character.
Get One Hit Kill State	Gets the one hit kill state from the debug settings.
Get Random Number	Gets a random number between 0 and x - 1.
Get Reflect Target	Gets the battle unit work address of the nearest opposing character.
Get Remedy Status Effects	Gets status effects that are nullified by remedy lores.
Get Status Effect Duration	Gets a status effect's duration based on target's vitality and augments (spellbound).
Get Status Effect Tick Duration	Gets a status effect's tick duration.
Get Status Effects Match	Checks if 2 status effect combinations have at least one match.
Get Terrain Type	Gets the type of the terrain a character is currently standing on.
Get Weather	Gets the weather of the current location.
Is Interactable	Returns whether the caster can interact with the target or not.
Modify Content	Adds or removes a content from your inventory.
Modify Gil	Adds or removes Gil from your inventory.
Modify Hp	Adds or removes hp from a character.
Modify Mist Charges	Adds or removes mist charges from a character.
Modify Mp	Adds or removes mp from a character.
Modify Sky Pirates Den Stats	Modifies the stats of a figure in the Sky Pirate's Den.
Refresh Stats	Refreshes a character's stats, status effects, status effect immunities, augments, mp, and mist bars.
Remove Augment	Removes an augment from a character.
Remove Status Effect	Removes a status effect from a character.
Set Level	Sets a character's level to a specific value.
Shift Elements	Sets a single element as a weakness while absorbing all other elements.
Show Combat Log	Shows a message in the combat log window.
Show Number Text	Shows a number as text on a character.
Teleport Location	Teleports the party to a specific location.