Difference between revisions of "@Start"

From SphereWiki
Jump to: navigation, search
(Created page with '==Description== This trigger fires when an attempt to use skill has started. Fires on: * Skills ==References== The following object references are explicitly availa...')
 
(Arguments)
 
(2 intermediate revisions by one other user not shown)
Line 16: Line 16:
 
|-
 
|-
 
| [[SRC]] || The [[Characters|character]] starting to use the skill.
 
| [[SRC]] || The [[Characters|character]] starting to use the skill.
 +
|-
 +
| [[ACT]] || The [[Backpack|backpack]] trying to peek for snooping.
 
|}
 
|}
 
  
 
==Arguments==
 
==Arguments==
Line 32: Line 33:
 
|-
 
|-
 
| LOCAL.CRAFTSTROKECNT || IO || For crafting skills, the number of 'strokes' until the skill completes.
 
| LOCAL.CRAFTSTROKECNT || IO || For crafting skills, the number of 'strokes' until the skill completes.
 +
|-
 +
| local.GatherStrokeCnt || IO || For gathering skills, the number of 'strokes' until the skill completes.
 
|}
 
|}
 
  
 
==Return Values==
 
==Return Values==

Latest revision as of 16:44, 19 July 2017

Description

This trigger fires when an attempt to use skill has started.


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
I The character starting to use the skill.
SRC The character starting to use the skill.
ACT The backpack trying to peek for snooping.

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 The skill number that has started.
LOCAL.CRAFTAMOUNT IO For crafting skills, the amount of the item that will be created.
LOCAL.CRAFTITEMDEF IO For crafting skills, the item BASEID that will be created.
LOCAL.CRAFTSTROKECNT IO For crafting skills, the number of 'strokes' until the skill completes.
local.GatherStrokeCnt IO For gathering skills, the number of 'strokes' until the skill completes.

Return Values

The following return values are explicitly defined for this trigger:

Return Value Description
1 Aborts the skill attempt.