View source for Lua Function Reference

This is a reference page of all the functions that can be called in Lua and their namespaces. See the main page for each namespace for further details.

== AI ==
{{main|AI (functions)}}

{| class="wikitable"
|-
! Function !! Description 
|-
| SetCharacterAI || Gives the ground character the assigned AI. 
|-
| DisableCharacterAI || Disables the AI processing of the ground character. 
|-
| EnableCharacterAI || Enables the AI processing of the ground character, if it has been disabled by DisableCharacterAI.
|-
| SetAIState|| ??? 
|}

== Dungeon == 
{{main|Dungeon (functions)}}

{| class="wikitable"
|-
! Function !! Description 
|-
| CharTurnToChar || Makes a character turn to face another.
|-
| LastDungeonResult||Gets the result of the last dungeon adventure.
|-
| DungeonCurrentFloor || Returns the floor number of the current dungeon. 
|-
| DungeonAssetName|| Returns the internal name for the current dungeon. 
|-
| DungeonDisplayName|| Returns the localized name of the current dungeon.
|-
| CharSetEmote|| Set a character's emote in a dungeon map.  
|-
| CharStartAnim|| Set a character's animation. 
|-
| CharEndAnim|| Stops a character's current animation, reverting them to default idle. 
|-
| PlayVFX|| Plays a VFX in the dungeon map 
|-
| PlayVFX|| Plays a VFX that has a start position and an end position. It uses a finite emitter that generates BaseAnims.
|-
| MoveScreen|| Plays a screen-moving effect. 
|}

== Game ==
{{main|Game (functions)}}
=== Game Control ===
{{main|Game (functions)/Game Control}}
{{:Ground (functions)/Game Control/Table}}

=== Map and Adventure Control ===
{{main|Game (functions)/Map and Adventure Control}}
{{:Game (functions)/Map and Adventure Control/Table}}

=== Rescue Management ===
{{main|Game (functions)/Rescue Management}}
{{:Game (functions)/Rescue Management/Table}}

=== Camera & Scene Control ===
{{main|Game (functions)/Camera & Scene Control}}
{{:Game (functions)/Camera & Scene Control/Table}}

=== Team Management ===
{{main|Game (functions)/Team Management}}
{{:Game (functions)/Team Management/Table}}
==== Party Management ====
{{main|Game (functions)/Party Management}}
{{:Game (functions)/Party Management/Table}}

==== Assembly Management ====
{{main|Game (functions)/Assembly Management}}
{{:Game (functions)/Assembly Management/Table}}

==== Guest Management ====
{{main|Game (functions)/Guest Management}}
{{:Game (functions)/Guest Management/Table}}

=== Character Control ===
{{main|Game (functions)/Character Control}}
{{:Game (functions)/Character Control/Table}}

=== Item Management ===
{{main|Game (functions)/Item Management}}
{{:Game (functions)/Item Management/Table}}

=== Money ===
{{main|Game (functions)/Money}}
{{:Game (functions)/Money/Table}}

=== Inputs ===
{{main|Game (functions)/Inputs}}
{{:Game (functions)/Inputs/Table}}

=== Dungeons ===
{{main|Game (functions)/Dungeons}}
{{:Game (functions)/Dungeons/Table}}

=== Direction ===
{{main|Game (functions)/Direction}}
{{:Game (functions)/Direction/Table}}

=== Queuing ===
{{main|Game (functions)/Queuing}}
{{:Game (functions)/Queuing/Table}}

== Ground ==
{{main|Ground (functions)}}

=== Entity ===
{{main|Ground (functions)/Entity}}
{{:Ground (functions)/Entity/Table}}

=== Entity Turning ===
{{main|Ground (functions)/Entity Turning}}
{{:Ground (functions)/Entity Turning/Table}}

=== Entity Movement ===
{{main|Ground (functions)/Entity Movement}}
{{:Ground (functions)/Entity Movement/Table}}

=== Entity Animation ===
{{main|Ground (functions)/Entity Animation}}
{{:Ground (functions)/Entity Animation/Table}}

=== Screen Effects ===
{{main|Ground (functions)/Screen Effects}}
{{:Ground (functions)/Screen Effects/Table}}

=== Leveling ===
{{main|Ground (functions)/Leveling}}
{{:Ground (functions)/Leveling/Table}}

=== Map Status ===
{{main|Ground (functions)/Map Status}}
{{:Ground (functions)/Map Status/Table}}

== Sound ==
{{main|Sound (functions)}}
{{:Sound (functions)/Table}}

== Strings ==
{{main|Strings (functions)}}
{{Sectstub}}
== Task ==
{{main|Task (functions)}}
{{Sectstub}}
== UI ==
{{main|UI (functions)}}
{{Sectstub}}

[[Category:Scripting]]
[[Category:Quick Reference]]