RPG in a Box
Official Documentation

User Tools

Site Tools

Trace:
entity_properties

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
entity_properties [2022/12/15 23:09] – justinentity_properties [2023/02/01 20:47] (current) – justin
Line 10: Line 10:
 |{{:wiki:script_start.png?nolink|}}|Trigger Event|List of possible trigger events for [[script|scripts]] assigned to this [[tile]]. Each trigger event can have its own [[script]]. Refer to the table below for a description of each trigger event.| |{{:wiki:script_start.png?nolink|}}|Trigger Event|List of possible trigger events for [[script|scripts]] assigned to this [[tile]]. Each trigger event can have its own [[script]]. Refer to the table below for a description of each trigger event.|
 |{{:wiki:script.png?nolink|}}|Script|Script that will be triggered for the currently selected trigger event. Selecting "Quick Script" from the dropdown box then clicking the pencil button will open the [[Quick Script Builder]].| |{{:wiki:script.png?nolink|}}|Script|Script that will be triggered for the currently selected trigger event. Selecting "Quick Script" from the dropdown box then clicking the pencil button will open the [[Quick Script Builder]].|
-|{{:wiki:tag_purple.png?nolink|}}|Entity ID|Unique ID for the tile that can be referenced in scripts. See [[Entity]] for an example of how to reference an entity by its ID.|+|{{:wiki:tag_id.png?nolink|}}|Entity ID|Unique ID for the tile that can be referenced in scripts. See [[Entity]] for an example of how to reference an entity by its ID.|
 |{{:wiki:information.png?nolink|}}|Tooltip|Text that will be displayed in-game when the player hovers over the tile with the mouse cursor. See [[Entity Tooltips]].| |{{:wiki:information.png?nolink|}}|Tooltip|Text that will be displayed in-game when the player hovers over the tile with the mouse cursor. See [[Entity Tooltips]].|
 |{{:wiki:cursor.png?nolink|}}|Interaction Cursor|Mouse cursor to display when the player character is able to walk to the tile and the mouse is hovering over it. For example, an icon of a staircase could be used for a dungeon entrance tile.| |{{:wiki:cursor.png?nolink|}}|Interaction Cursor|Mouse cursor to display when the player character is able to walk to the tile and the mouse is hovering over it. For example, an icon of a staircase could be used for a dungeon entrance tile.|
Line 16: Line 16:
 ====Script Trigger Events==== ====Script Trigger Events====
 ^Event^Description^ ^Event^Description^
-|Character enters tile| | +|Character enters tile|Triggered whenever a [[character]] enters this [[tile]]. In order for an [[NPC]] to trigger this event, the "Triggerable by NPCs" setting must be enabled, and the [[NPC]] must have "Can Trigger Scripts" enabled in their [[npc_behavior|behavior]] settings.| 
-|Character stops on tile| | +|Character stops on tile|Triggered whenever a [[character]] stops on this [[tile]]. In order for an [[NPC]] to trigger this event, the "Triggerable by NPCs" setting must be enabled, and the [[NPC]] must have "Can Trigger Scripts" enabled in their [[npc_behavior|behavior]] settings.| 
-|Character exits tile| | +|Character exits tile|Triggered whenever a [[character]] exits this [[tile]]. In order for an [[NPC]] to trigger this event, the "Triggerable by NPCs" setting must be enabled, and the [[NPC]] must have "Can Trigger Scripts" enabled in their [[npc_behavior|behavior]] settings.| 
-|Object enters tile| | +|Object enters tile|Triggered whenever a [[pushing|pushable object]] enters this [[tile]]. In order for an [[NPC]] to trigger this event, the "Triggerable by NPCs" setting must be enabled, and the [[NPC]] must have "Can Trigger Scripts" enabled in their [[npc_behavior|behavior]] settings. The **$object** local variable will contain the pushed [[object]].| 
-|Object stops on tile| | +|Object stops on tile|Triggered whenever a [[pushing|pushable object]] stops on this [[tile]]. In order for an [[NPC]] to trigger this event, the "Triggerable by NPCs" setting must be enabled, and the [[NPC]] must have "Can Trigger Scripts" enabled in their [[npc_behavior|behavior]] settings. The **$object** local variable will contain the pushed [[object]].| 
-|Object exits tile| | +|Object exits tile|Triggered whenever a [[pushing|pushable object]] exits this [[tile]]. In order for an [[NPC]] to trigger this event, the "Triggerable by NPCs" setting must be enabled, and the [[NPC]] must have "Can Trigger Scripts" enabled in their [[npc_behavior|behavior]] settings. The **$object** local variable will contain the pushed [[object]].| 
-|Item (Tool)| |+|Item (Tool)|Triggered whenever the player interacts with this [[tile]] while they have the corresponding [[tool_items|tool item]] active. An [[item]] needs to be configured as a [[tool_items|tool item]] in order for it to appear as a trigger event.|
  
 =====Object Properties===== =====Object Properties=====
 ^Icon^Property^Description^ ^Icon^Property^Description^
 |{{:wiki:script.png?nolink|}}|Script|Script that will be triggered when the player interacts with the object. Selecting "Quick Script" from the dropdown box then clicking the pencil button will open the [[Quick Script Builder]].| |{{:wiki:script.png?nolink|}}|Script|Script that will be triggered when the player interacts with the object. Selecting "Quick Script" from the dropdown box then clicking the pencil button will open the [[Quick Script Builder]].|
-|{{:wiki:tag_purple.png?nolink|}}|Entity ID|Unique ID for the object that can be referenced in scripts. See [[Entity]] for an example of how to reference an entity by its ID.|+|{{:wiki:tag_id.png?nolink|}}|Entity ID|Unique ID for the object that can be referenced in scripts. See [[Entity]] for an example of how to reference an entity by its ID.|
 |{{:wiki:information.png?nolink|}}|Tooltip|Text that will be displayed in-game when the player hovers over the object with the mouse cursor. See [[Entity Tooltips]].| |{{:wiki:information.png?nolink|}}|Tooltip|Text that will be displayed in-game when the player hovers over the object with the mouse cursor. See [[Entity Tooltips]].|
 |{{:wiki:cursor.png?nolink|}}|Interaction Cursor|Mouse cursor to display when the player character is able to interact with the object and the mouse is hovering over it. For example, an icon of a key could be used for a locked door or chest.| |{{:wiki:cursor.png?nolink|}}|Interaction Cursor|Mouse cursor to display when the player character is able to interact with the object and the mouse is hovering over it. For example, an icon of a key could be used for a locked door or chest.|
-|{{:wiki:box.png?nolink|}}|Item Container|When enabled, the object will act as an [[item container]]. When the player interacts with the object, an [[item container]] window will open, allowing the player to take items from (or place items into) the object.| +|{{:wiki:chest.png?nolink|}}|Item Container|When enabled, the object will act as an [[item container]]. When the player interacts with the object, an [[item container]] window will open, allowing the player to take items from (or place items into) the object.| 
-|{{:wiki:box.png?nolink|}}|On Close Script|Script that will be triggered whenever the item container window is closed by the player (or if they walk away from the object). Only applicable if the object is defined as an item container.| +|{{:wiki:chest.png?nolink|}}|On Close Script|Script that will be triggered whenever the item container window is closed by the player (or if they walk away from the object). Only applicable if the object is defined as an item container.| 
-|{{:wiki:box.png?nolink|}}|Container Name|Text that will show in the titlebar of the item container window (for example, "Wooden Chest"). Only applicable if the object is defined as an item container.|+|{{:wiki:chest.png?nolink|}}|Container Name|Text that will show in the titlebar of the item container window (for example, "Wooden Chest"). Only applicable if the object is defined as an item container.|
  
 =====Character Properties===== =====Character Properties=====
 ^Icon^Property^Description^ ^Icon^Property^Description^
-|{{:wiki:user_gray.png?nolink|}}|Character Type|Specifies whether the character is an NPC or an enemy. NPCs can have dialogue attached, and enemies can have battles attached.| +|{{:wiki:character_npc.png?nolink|}}|Character Type|Specifies whether the character is an NPC or an enemy. NPCs can have dialogue attached, and enemies can have battles attached.| 
-|{{:wiki:comment.png?nolink|}}|Dialogue|Dialogue that will be triggered when the player interacts with the character. Only applicable to NPCs.| +|{{:wiki:dialogue.png?nolink|}}|Dialogue|Dialogue that will be triggered when the player interacts with the character. Only applicable to NPCs.| 
-|{{:wiki:bomb.png?nolink|}}|Battle|Battle that will be triggered when the player interacts with the character. Only applicable to enemies.|+|{{:wiki:swords.png?nolink|}}|Battle|Battle that will be triggered when the player interacts with the character. Only applicable to enemies.|
 |{{:wiki:navigation.png?nolink|}}|Behavior|Determines how the character will move around the map and react to their surroundings. See [[NPC Behavior]].| |{{:wiki:navigation.png?nolink|}}|Behavior|Determines how the character will move around the map and react to their surroundings. See [[NPC Behavior]].|
-|{{:wiki:tag_purple.png?nolink|}}|Entity ID|Unique ID for the character that can be referenced in scripts. See [[Entity]] for an example of how to reference an entity by its ID.|+|{{:wiki:tag_id.png?nolink|}}|Entity ID|Unique ID for the character that can be referenced in scripts. See [[Entity]] for an example of how to reference an entity by its ID.|
 |{{:wiki:information.png?nolink|}}|Tooltip|Text that will be displayed in-game when the player hovers over the character with the mouse cursor. See [[Entity Tooltips]].| |{{:wiki:information.png?nolink|}}|Tooltip|Text that will be displayed in-game when the player hovers over the character with the mouse cursor. See [[Entity Tooltips]].|
  
 ~~NOTOC~~ ~~NOTOC~~
entity_properties.1671174544.txt.gz · Last modified: 2022/12/15 23:09 by justin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki