Difference between revisions of "@Step"
From SphereWiki
MrSugarCube (talk | contribs) (Created page with '==Description== This trigger fires when an item is stepped on by a character. After being stepped on, this trigger will periodically fire until the character steps off the item. ...') |
MrSugarCube (talk | contribs) |
||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | This trigger fires when an item is stepped on by a character. | + | This trigger fires when an item or region is stepped on by a character. When an item is stepped, this trigger will periodically fire until the character steps off the item. For regions, the trigger only fires when the character takes a step. |
Fires on: | Fires on: | ||
* [[Items]] | * [[Items]] | ||
| + | * [[Regions]] | ||
| Line 13: | Line 14: | ||
| '''Name''' || '''Description''' | | '''Name''' || '''Description''' | ||
|- | |- | ||
| − | | [[I]] || The [[Items|item]] being stepped on. | + | | [[I]] || The [[Items|item]] or [[Regions|region]] being stepped on. |
|- | |- | ||
| − | | [[SRC]] || The [[Characters|character]] stepping on the item. | + | | [[SRC]] || The [[Characters|character]] stepping on the item or region. |
|} | |} | ||
| Line 35: | Line 36: | ||
| '''Return Value''' || '''Description''' | | '''Return Value''' || '''Description''' | ||
|- | |- | ||
| − | | 1 || Prevents the item from being stepped on. | + | | 1 || Prevents the item or region from being stepped on. |
|} | |} | ||
Latest revision as of 23:27, 19 June 2009
Description
This trigger fires when an item or region is stepped on by a character. When an item is stepped, this trigger will periodically fire until the character steps off the item. For regions, the trigger only fires when the character takes a step.
Fires on:
References
The following object references are explicitly available for this trigger:
| Name | Description |
| I | The item or region being stepped on. |
| SRC | The character stepping on the item or region. |
Arguments
The following arguments are set for this trigger. If an argument is marked as "In" then a value will be passed in to the trigger, if an argument is marked as "Out" then it can be set to a value to affect Sphere's behaviour:
| Argument | In/Out | Description |
| ARGN1 | I | If 1, the character is standing still on the item. |
Return Values
The following return values are explicitly defined for this trigger:
| Return Value | Description |
| 1 | Prevents the item or region from being stepped on. |
