Difference between revisions of "@Mount"
From SphereWiki
MrSugarCube (talk | contribs) (Created page with '==Description== This trigger fires when a character attempts to mount a rideable creature. Fires on: * Characters ==References== The following object references are expli...') |
(Add ARGN1 argument and note) |
||
| Line 24: | Line 24: | ||
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: | 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: | ||
| + | {| border="1" cellspacing="4" cellpadding="4" | ||
| + | | '''Argument''' || '''In/Out''' || '''Description''' | ||
| + | |- | ||
| + | | ARGN1 || IO || The itemID of the item containing the animation use when moounting.(Anim # is in tiledata of this item) [Sphere X] | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | NOTE: When mounting a pet you'll read a non sense random value in ARGN1 but you can replace it by an ITEMID to force anim | ||
| + | EX: 03ea6 for Llama anim or 03e9f for gray horse anim. Yes 03ea6 is a ship part but in tiledata it link to anim 828 | ||
| − | |||
Latest revision as of 20:04, 17 November 2023
Description
This trigger fires when a character attempts to mount a rideable creature.
Fires on:
References
The following object references are explicitly available for this trigger:
| Name | Description |
| ARGO | The creature being mounted. |
| I | The character attempting to mount the creature. |
| SRC | The character attempting to mount the creature. |
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 | IO | The itemID of the item containing the animation use when moounting.(Anim # is in tiledata of this item) [Sphere X] |
NOTE: When mounting a pet you'll read a non sense random value in ARGN1 but you can replace it by an ITEMID to force anim EX: 03ea6 for Llama anim or 03e9f for gray horse anim. Yes 03ea6 is a ship part but in tiledata it link to anim 828
Return Values
The following return values are explicitly defined for this trigger:
| Return Value | Description |
| 1 | Prevents the character from mounting the creature. |