Game (functions)
From PMDOWiki
More functions: Script Reference
The game functions are used for various tasks across the game that happen in multiple contexts. Due to the size of the namespace, it is split into subpages based on what each function does.
Game Control
Subpage: Game (functions)/Game Control
| Function | Description |
|---|---|
| GroundSave | Saves the game while in ground mode. |
| GetModDiff | (undocumented) |
| RestartToTitle | Leave the current map and load the title screen. |
| RestartRogue | Restarts a roguelocke run based on the configuration. |
| CutsceneMode | Turns cutscene mode on or off. |
Map and Adventure Control
| Function | Description |
|---|---|
| GetCurrentGround | Returns the current ground map. |
| GetCurrentFloor | Returns the current dungeon map. |
| GetCurrentDungeon | Returns the current zone (aka dungeon). |
| EnterGroundMap | Enter the specified ground map. |
| EnterDungeon | Enter the specified dungeon. |
| ContinueDungeon | Enter the zone and continue the current ongoing adventure. |
| EndDungeonRun | Enter the zone and continue the current ongoing adventure. |
| EnterZone | Enter the zone and begin an adventure. |
Rescue Management
Subpage: Game (functions)/Rescue Management
| Function | Description |
|---|---|
| EnterRescue | Enter a zone and begin a rescue. |
| AddAOKRemark | (Undocumented) |
| HasSOSMail | (Undocumented) |
| HasAOKMail | (Undocumented) |
| GetRescueAllowed | Returns true if rescues are allowed, false otherwise. |
| SetRescueAllowed | Sets a flag in the player's save file to determined if they can be rescued or not. |
Camera & Scene Control
| Function | Description |
|---|---|
| FadeOut | Fades screen out, waits to finish. |
| FadeIn | Fades screen in, waits to finish. |
| MoveCamera | Moves the camera. |
| MoveCameraToChara | Moves the camera to the specified character. |
| GetCameraCenter | Returns the current center of the camera. |
| IsCameraOnChar | Returns true if the camera is centered relative to the player, false if not. |
Team Management
Subpage: Game (functions)/Team Management
| Function | Description |
|---|---|
| GetTeamLeaderIndex | Returns the index of the currently player controlled entity in the party. |
| SetTeamLeaderIndex | Sets the leader to the chosen index in the party. |
| SetCanSwitch | Configure the ability to switch leaders in the save file. |
| SetCanRecruit | Configure the ability to recruit in the save file. |
| SetTeamName | Sets the name of the player's team. |
| GetTeamName | Gets the name of the player's team. Returns the name of the team. |
Party Management
Subpage: Game (functions)/Party Management
| Function | Description |
|---|---|
| GetPlayerPartyCount | Returns the player's party count. |
| GetPlayerPartyTable | Returns the player's party as a lua table, excluding guests. |
| GetPlayerPartyMember | Returns the party member at the specified team index. |
| AddPlayerTeam | Adds the given character to the player's team. |
| RemovePlayerTeam | Removes the character from the given slot from the team. |
Assembly Management
Subpage: Game (functions)/Assembly Management
| Function | Description |
|---|---|
| GetPlayerAssemblyCount | Returns the amount of characters currently in the player's assembly. |
| GetPlayerAssemblyTable | Returns the player's assembly as a lua table. |
| GetPlayerAssemblyMember | Gets the character at the specified index from the assembly. |
| AddPlayerAssembly | Adds the given character to the player's assembly. |
| RemovePlayerAssembly | Removes the character from the given slot from the assembly. |
Guest Management
Subpage: Game (functions)/Guest Management
| Function | Description |
|---|---|
| GetPlayerGuestCount | Returns the amount of guests currently in the player's party. |
| GetPlayerGuestTable | Returns the player's party guests as a lua table. |
| GetPlayerGuestMember | Gets the character at the specified index from the guests. |
| AddPlayerGuest | Adds the given character to the player's guest list. |
| RemovePlayerGuest | Removes the character from the given slot from the guest list. |
Character Control
Subpage: Game (functions)/Character Control
| Function | Description |
|---|---|
| SetCharacterNickname | Sets a character's nickname. |
| GetCharacterNickname | Returns the nickname of the passed character. |
| CanRelearn | Checks if the character can relearn any skills. Returns true if they can, false if they can't. |
| CanForget | Checks if the character can forget any skills. Returns true if they can, false if they can't. |
| CanLearn | Checks if the character can learn any skills. |
| CheckLevelSkills | Checks the levels gained by a character and prompts to learn all skills along the levels. |
| TryLearnSkill | Attempts to give a new skill to the specified character, prompting to replace an old one if they are full. |
| LearnSkill | Gives a new skill to a specified character. Fails if the character's skills are full. |
| ForgetSkill | Removes a skill from the specified character. |
| LockSkill | Makes a skill impossible to forget or replace for the specified character. |
| UnlockSkill | Unlocks a previously locked skill for the specified character, making it possible to be forgotten or replaced during normal gameplay. |
| SetCharacterSkill | Gives a new skill to a specified character, replacing a specifically chosen slot. |
| GetCharacterSkill | Gets the skill from a specified character and specified slot. |
| CanPromote | Checks if the character can be promoted to a new class. (In PMDO, this is evolution.) |
| GetAvailablePromotions | Gets a list of possible classes that the character can promote to. (In PMDO, this is evolution.) |
| PromoteCharacter | Promotes a character to a new class. (In PMDO, this is evolution.) |
Item Management
Subpage: Game (functions)/Item Management
| Function | Description |
|---|---|
| FindPlayerItem | Finds an item in the player's team and returns its slot within the inventory or among its team's equips. |
| GetPlayerEquippedCount | Returns the number of items equipped by players. Does not include guests. |
| GetPlayerBagCount | Returns the number of items in the bag. |
| GetPlayerBagLimit | Returns the maximum amount of item the player's team can carry. |
| GetPlayerEquippedItem | Returns the equipped item for the character in the specified slot. |
| GetGuestEquippedItem | Returns the equipped item for the character in the specified guest slot. |
| GivePlayerItem | Gives an item and adds it to the player team's bag. |
| GetPlayerBagItem | Returns the item found at the specified slot of the player's bag. |
| TakePlayerBagItem | Remove an item from player's inventory. |
| akePlayerEquippedItem | Remove the equipped item from a chosen member of the team. |
| TakeGuestEquippedItem | Remove the equipped item from a chosen guest of the team. |
| GetPlayerStorageCount | Returns the amount of items in the player's storage |
| GetPlayerStorageItemCount | Returns the amount of a specific item in the player's storage |
| GivePlayerStorageItem | Returns an item and adds it to the player team's storage. |
| GivePlayerStorageItem | Gives an item and adds it to the player team's storage. |
| TakePlayerStorageItem | Takes an item from the storage |
| DepositAll | Takes all items in the player team's bag and equipped items, and deposits them in storage. |
Money
Subpage: Game (functions)/Money
| Function | Description |
|---|---|
| GetPlayerMoney | Returns the amount of money the player currently has on hand. |
| AddToPlayerMoney | Adds money to the player's wallet. |
| RemoveFromPlayerMoney | Removes money from the player's wallet. |
| AddToPlayerMoneyBank | Adds money to the player's bank. |
| RemoveFromPlayerMoneyBank | Removes money from the player's bank. |
Inputs
Subpage: Game (functions)/Inputs
| Function | Description |
|---|---|
| IsKeyDown | Checks if a player is making a certain physical keyboard input. Returns true if the button is currently being pressed, false otherwise. |
| IsInputDown | Checks if a player is making a certain game input. Returns true if the input is currently pressed, false otherwise. |
Dungeons
Subpage: Game (functions)/Dungeons
| Function | Description |
|---|---|
| GetDailySeed | Returns the random seed for the current adventure. |
| UnlockDungeon | Unlocks the specified dungeon. |
| DungeonUnlocked | Returns true if the specified dungeon is unlocked, false if not. |
Direction
Subpage: Game (functions)/Direction
| Function | Description |
|---|---|
| VectorToDirection | Convenience function to get a vector's components from lua numbers. May take either a single integer or a vector in an X and Y value. |
| RandomDirection | Generates a random direction. Returns an 8-directional direction. |
Queuing
Subpage: Game (functions)/Queuing
| Function | Description |
|---|---|
| QueueLeaderEvent | Prepares an event to execute on the next frame. |
| WaitFrames | Waits for a specified number of frames before continuing. |
