Entity

Summary

Entities represent interactable objects. These are used for NPCs, treasure chests, random environmental objects, and more.

For entities that have the exact same logic and interactions, consider using an Entity Definition.

Scripts

Entity scripts allow for an entity to support multiple interactions and types. Unlike other engines, RPG Architect will leverage the first script to satisfy all conditions and interactions.

Entity Script

Properties

System

Name	Explanation	Type
Script Name	The name of the script.	String
Conditions	The conditions for priority of the script.	Condition ?
Interactions	The methods of interaction for the script.	Interaction ?

Visual

Name	Explanation	Type
Cycle Animation	Whether or not to animate the entity automatically.	Toggle
Recycle Animation	Whether or not to continuously animate the entity.	Toggle
Direction	The direction the entity is facing, if applicable.	Direction
Fix Direction	Whether or not to keep the entity facing its current direction. This will not prevent direction changes through scripts or Face On Interaction.	Toggle
Face On Interaction	Whether or not the entity will face the player on interaction.	Toggle
Interaction Suspends Movement	Whether or not to suspend the movement pattern when interaction occurs.	Toggle
Sprite / Model	The sprite or model of the entity on maps.	Sprite Or Model
Shape	The shape of the entity in 3D.	Shape
Pitch (X Rotation)	The transformation, in 3D, of the entity along the X Axis.	Number
Yaw (Y Rotation)	The transformation, in 3D, of the entity along the Y Axis.	Number
Roll (Z Rotation)	The transformation, in 3D, of the entity along the Z Axis.	Number
Annotations	The annotations associated with the current script page.	Annotation ?

Physics

Name	Explanation	Type
Delay	The delay between movement actions, in milliseconds.	Number
Ignore Entity Collision	Whether or not to ignore collisions with other entities and doodads.	Toggle
Ignores Gravity	Whether or not the entity ignores the effects of gravity.	Toggle
Ignores Obstacles	Whether or not the entity ignores obstacles created by terrain/tile collisions.	Toggle
Is Clipping	Whether or not the entity operates independently of physics. Interactions can still occur.	Toggle
Is Pushable	Whether or not the entity can be pushed.	Toggle
Prevent Collision	Whether or not the entity tries to avoid occupying the same tile or location as another entity.	Toggle
Prevent Falling	Whether or not the entity tries to avoid falling.	Toggle
Register Ignored Collisions	Whether or not the entity registers collisions (and therefore interactions) with other objects, when Ignore Entity Collision is enabled.	Toggle
Speed	The speed multiplier of the entity.	Float

Movement

Name	Explanation	Type
Movement Type	The type of movement that the entity will have.	Movement Type ?
Movement Path	The custom movement path the entity will take if Movement Type is set to Path.	Movement ?

Lighting

Name	Explanation	Type
Color	The color of light emitted.	Color
Is Flickering	Whether or not the light flickers.	Toggle
Flicker Duration	The duration between flicker changes, in milliseconds.	Number
Is Light	Whether or not the entity illuminates light.	Toggle
Maximum Intensity	The maximum intensity of the light.	Number
Maximum Radius	The maximum radius of the light, in tiles.	Number
Minimum Intensity	The minimum intensity of the light.	Number
Minimum Radius	The minimum radius of the light, in tiles.	Number
Offset X	The x offset of the light.	Number
Offset Y	The y offset of the light.	Number
Offset Z	The z offset of the light.	Number

Collision

Name	Explanation	Type
Collider	The settings for the dimensions and type of collider. Values are measured in tiles.	Collider ?

Script

The Script to execute when all of the Conditions and Interactions are met.

Configuration

Local Data

Name	Explanation	Type
Switches	The local switches attached to the entity.	Switch
Variables	The local variables attached to the entity.	Variable