Skip to content
RPG Architect Documentation
Variable Definitions
Initializing search
RPG Architect Documentation
Welcome
Welcome
Guides
Guides
Getting Started
Getting Started
Frequently Asked Questions
Frequently Asked Questions
Reporting Bugs
Reporting Bugs
Troubleshooting
Troubleshooting
Tutorials
Tutorials
Cookbook
Cookbook
Changing Tile Size
Changing Tile Size
Sprite And Model Priority
Sprite And Model Priority
2D Cookbook
2D Cookbook
Layer Rendering
Layer Rendering
Pixel Perfect Rendering
Pixel Perfect Rendering
3D Cookbook
3D Cookbook
Modeling Best Practices
Modeling Best Practices
Editor
Editor
Database
Database
Map Editor
Map Editor
Entity Reference
Entity Reference
Switch Definitions
Switch Definitions
Variable Definitions
Variable Definitions
Reference
Reference
3D Model
3D Model
Actor Reference
Actor Reference
Annotations
Annotations
Annotation Effects
Annotation Effects
Array
Array
Audio
Audio
Collider
Collider
Conditions
Conditions
Context
Context
Direction
Direction
Easing Function
Easing Function
Entity
Entity
Filter
Filter
Font
Font
Formulas
Formulas
Graphics Post Processors
Graphics Post Processors
Image
Image
Interaction
Interaction
Light
Light
Local And Global Data
Local And Global Data
Map
Map
Movement Elements
Movement Elements
Music
Music
Physics Object Reference
Physics Object Reference
Projection Elements
Projection Elements
Projection Element Modifiers
Projection Element Modifiers
Reference Switch Or Variable
Reference Switch Or Variable
Scene
Scene
Scene Transitions
Scene Transitions
Script
Script
Sound Effect
Sound Effect
Sprite Format
Sprite Format
Sprite Or Model
Sprite Or Model
Statistics Table
Statistics Table
Switch
Switch
Switch Or Value
Switch Or Value
Tag Context Provider
Tag Context Provider
Tags
Tags
Text Escape Codes
Text Escape Codes
Tileset Format
Tileset Format
Trait Effect Table
Trait Effect Table
Trait Table
Trait Table
Unique ID
Unique ID
Variable
Variable
Variable Manipulators
Variable Manipulators
Variable Or Value
Variable Or Value
Video
Video
Database
Database
Characters
Characters
Characters
Characters
Classes
Classes
Character Animations
Character Animations
Portrait Expressions
Portrait Expressions
Sprite Layers
Sprite Layers
Skills
Skills
Skill Settings
Skill Settings
Skills
Skills
Skill Types
Skill Types
Items
Items
Configuration
Configuration
Items
Items
Equipment
Equipment
Loot Tables
Loot Tables
Equipment Slots
Equipment Slots
Item Types
Item Types
Maps
Maps
Configuration
Configuration
Tilesets
Tilesets
Tile Tags
Tile Tags
Doodads
Doodads
Entities
Entities
Vehicles
Vehicles
Weather
Weather
Projections
Projections
Entity Definitions
Entity Definitions
Data Entries
Data Entries
Data Entries
Data Entries
Data Entry Types
Data Entry Types
Statistics
Statistics
Statistics
Statistics
Elementals
Elementals
Status Effects
Status Effects
Enemies
Enemies
Enemies
Enemies
Enemy Formations
Enemy Formations
Battles
Battles
Configuration
Configuration
Battle Backdrops
Battle Backdrops
Action Sequences
Action Sequences
Battle Poses
Battle Poses
Animations
Animations
Animations
Animations
User Interfaces
User Interfaces
User Interfaces
User Interfaces
Font Families
Font Families
System
System
Video Configuration
Video Configuration
Audio Configuration
Audio Configuration
General
General
Localizations
Localizations
Title
Title
New Game
New Game
Game Over
Game Over
Virtual Keys
Virtual Keys
Controllers
Controllers
Global Scripts
Global Scripts
Functions
Functions
Commands
Commands
Data Manipulation
Data Manipulation
Change Switch
Change Switch
Change Variable
Change Variable
Array Operations
Array Operations
Save Unique ID
Save Unique ID
Save Value
Save Value
Variable Manipulation
Variable Manipulation
Modify Tags
Modify Tags
Change Name
Change Name
Evaluate Formula
Evaluate Formula
Save State Management
Save State Management
Load State
Load State
Save State
Save State
Delete State
Delete State
Audio
Audio
Play Sound Effect
Play Sound Effect
Play Music
Play Music
Toggle Music
Toggle Music
Stop Music
Stop Music
Play Background Effect
Play Background Effect
Stop Background Effect
Stop Background Effect
Set Master Volume
Set Master Volume
Message
Message
Display Static Message
Display Static Message
Display Dynamic Message
Display Dynamic Message
Dismiss Message
Dismiss Message
Display Dialogue Options
Display Dialogue Options
Display All Messages
Display All Messages
Inventory
Inventory
Change Inventory
Change Inventory
Clear Inventory
Clear Inventory
Change Money
Change Money
Clone Item
Clone Item
Destroy Item
Destroy Item
Get Item Quantity
Get Item Quantity
Use Inventory Item
Use Inventory Item
Equip Hero
Equip Hero
Unequip Hero
Unequip Hero
Character
Character
Change Statistic
Change Statistic
Change Status Effect
Change Status Effect
Restore Character
Restore Character
Change Class
Change Class
Skill
Skill
Change Skill
Change Skill
Use Skill
Use Skill
Party
Party
Add Character
Add Character
Remove Character
Remove Character
Change Party Member
Change Party Member
Swap Party Member
Swap Party Member
Restore Party
Restore Party
Animation
Animation
Play Animation
Play Animation
Stop Animation
Stop Animation
Add Annotations
Add Annotations
Remove Annotations
Remove Annotations
Set Character Animation
Set Character Animation
Set Battle Pose
Set Battle Pose
Set Portrait Expression
Set Portrait Expression
Rotate Object
Rotate Object
Flash Screen
Flash Screen
Shake Screen
Shake Screen
Tint Screen
Tint Screen
Show Screen
Show Screen
Hide Screen
Hide Screen
Physics
Physics
Apply Velocity
Apply Velocity
Alter Physics Properties
Alter Physics Properties
Alter Collider
Alter Collider
Alter Gravity
Alter Gravity
Map
Map
Teleport
Teleport
Reset Map
Reset Map
Get Tile Information
Get Tile Information
Change Movement Type
Change Movement Type
Change Tileset Image
Change Tileset Image
Adjust Camera
Adjust Camera
Adjust Lighting
Adjust Lighting
Adjust Light
Adjust Light
Set Camera Type
Set Camera Type
Set Camera Target
Set Camera Target
Add Weather
Add Weather
Change Weather
Change Weather
Delete Weather
Delete Weather
Clear Weather
Clear Weather
Adjust Map Layer
Adjust Map Layer
Entity And Vehicle
Entity And Vehicle
Spawn Entity
Spawn Entity
Remove Entity
Remove Entity
Move Entity
Move Entity
Spawn Vehicle
Spawn Vehicle
Remove Vehicle
Remove Vehicle
Stop Entity
Stop Entity
Change Character Model
Change Character Model
Cancel Vehicle Exit
Cancel Vehicle Exit
Change Portrait Model
Change Portrait Model
Change Battle Model
Change Battle Model
Jump
Jump
Access Entity Local Variable
Access Entity Local Variable
Access Entity Local Switch
Access Entity Local Switch
Save Entity Unique ID
Save Entity Unique ID
Projection
Projection
Spawn Projection
Spawn Projection
Remove Projection
Remove Projection
Battle
Battle
Start Battle
Start Battle
Schedule Battle Command
Schedule Battle Command
Show Battle Command Targets
Show Battle Command Targets
Clear Battle Command Targets
Clear Battle Command Targets
Alter Battle Command
Alter Battle Command
End Battle
End Battle
Change Battler Position
Change Battler Position
Add Battle Log
Add Battle Log
Clear Battle Log
Clear Battle Log
Change Battle Speed
Change Battle Speed
Set Encounter Steps
Set Encounter Steps
Change Battle Counter
Change Battle Counter
Control Flow
Control Flow
Conditional (If Then Else)
Conditional (If Then Else)
Switch Conditional
Switch Conditional
Wait
Wait
Toggle Controls
Toggle Controls
Fixed Loop
Fixed Loop
Comment
Comment
Conditional Loop
Conditional Loop
Break
Break
Exit Script
Exit Script
Code Block
Code Block
Main Menu
Main Menu
Toggle Main Menu Lock
Toggle Main Menu Lock
Open Main Menu
Open Main Menu
Change Main Menu
Change Main Menu
Picture
Picture
Show Picture
Show Picture
Change Picture
Change Picture
Hide Picture
Hide Picture
Clear Pictures
Clear Pictures
Video
Video
Play Video
Play Video
Change Video
Change Video
Pause Video
Pause Video
Resume Video
Resume Video
Stop Video
Stop Video
User Interface
User Interface
Open Menu
Open Menu
Close Menu
Close Menu
Open Overlay
Open Overlay
Open Text Entry
Open Text Entry
Refresh Overlay
Refresh Overlay
Push Focus
Push Focus
Save Context Unique ID
Save Context Unique ID
Set User Interface Element Context
Set User Interface Element Context
Refresh User Interface Element Context
Refresh User Interface Element Context
Reset User Interface Element Selection
Reset User Interface Element Selection
Pop Focus
Pop Focus
Toggle User Interface Element Visibility
Toggle User Interface Element Visibility
Get Selected Item Index
Get Selected Item Index
Set Selected Item Index
Set Selected Item Index
Close User Interface
Close User Interface
System
System
Run Global Script
Run Global Script
Call Function
Call Function
Change Game Speed
Change Game Speed
Change Text Speed
Change Text Speed
Change Background Color
Change Background Color
Change Mouse
Change Mouse
Run JSON Command
Run JSON Command
Launch Url
Launch Url
Change Graphics
Change Graphics
Set Localization
Set Localization
Shop
Shop
Open Shop
Open Shop
Adjust Shop Item Quantity
Adjust Shop Item Quantity
Buy Shop Item
Buy Shop Item
Sell To Shop
Sell To Shop
Scene
Scene
Title
Title
New Game
New Game
Reset Game
Reset Game
Game Over
Game Over
Exit
Exit
Data Sources
Data Sources
Background Effect
Background Effect
Battle Action
Battle Action
Battle Command
Battle Command
Battle Manager
Battle Manager
Battle Summary
Battle Summary
Battler
Battler
Camera
Camera
Class
Class
Data Entries
Data Entries
Data Management
Data Management
Database - Characters
Database - Characters
Database - Data Entries
Database - Data Entries
Database - Equipment
Database - Equipment
Database - Items
Database - Items
Database - Status Effects
Database - Status Effects
Equipment
Equipment
Equipment Slot
Equipment Slot
Game
Game
Game Statistics
Game Statistics
Graphics And Video
Graphics And Video
Hero
Hero
Hero Battle Summary
Hero Battle Summary
Input
Input
Inventory Slot
Inventory Slot
Item
Item
Map
Map
Music
Music
Party
Party
Physics Object
Physics Object
Projection
Projection
RPG Save State
RPG Save State
Scene
Scene
Shop
Shop
Shop Category
Shop Category
Shop Item
Shop Item
Shop Item Cost
Shop Item Cost
Shop Sell Item
Shop Sell Item
Skill
Skill
User Interface
User Interface
Animations
Animations
Elements
Elements
Effect Frame
Effect Frame
Graphic Frame
Graphic Frame
Particle Emitter
Particle Emitter
Shake
Shake
Sound Effect
Sound Effect
Target Effect
Target Effect
Particle Effects
Particle Effects
User Interfaces
User Interfaces
User Interface Contexts
User Interface Contexts
User Interface Elements
User Interface Elements
Compass List
Compass List
Folder
Folder
Gauge
Gauge
List
List
Pane
Pane
Picture
Picture
Slider
Slider
Templated List
Templated List
Text
Text
User Interface Element Effect
User Interface Element Effect
User Interface Transitions
User Interface Transitions
User Interface Types
User Interface Types
Dialogue
Dialogue
Menu
Menu
Message Box
Message Box
Overlay
Overlay
Shop
Shop
Text Entry
Text Entry
Battles
Battles
Action Sequences
Action Sequences
Elements
Elements
Absolute Movement
Absolute Movement
Animation
Animation
Battle Log
Battle Log
Battle Pose
Battle Pose
Clear Battle Log
Clear Battle Log
Color Flash
Color Flash
Color Mask
Color Mask
Conditional
Conditional
Loop
Loop
Relative Movement
Relative Movement
Relative Offset Movement
Relative Offset Movement
Result
Result
Result Modifier
Result Modifier
Sound Effect
Sound Effect
Switch
Switch
Variable
Variable
Virtual Key
Virtual Key
Visibility
Visibility
Wait
Wait
Action Sequence Result
Action Sequence Result
Battle Action Results
Battle Action Results
Battle Conditions
Battle Conditions
Programs
Programs
Add Enemy
Add Enemy
Alter Statistic
Alter Statistic
Alter Status Effect
Alter Status Effect
Battle Log
Battle Log
Battle Table
Battle Table
Clear Battle Log
Clear Battle Log
Do Nothing
Do Nothing
Global Switch
Global Switch
Global Variable
Global Variable
Replace Enemy
Replace Enemy
Set Battle Pose
Set Battle Pose
Use Skill
Use Skill
Wait
Wait
Battle Rewards
Battle Rewards
Setup Sequences
Setup Sequences
Table of contents
Variable Definitions
Variable Definitions
Variable Definitions
¶
Back to top