@SkillStart

From SphereWiki
Jump to: navigation, search

Description

This trigger fires when a character has begun an attempt to use a skill.


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.


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.