Difference between revisions of "@SkillMenu"

From SphereWiki
Jump to: navigation, search
(Created page with '==Description== This trigger fires when a skill menu is displayed to a player. Note that the trigger only fires when Sphere attempts to display the menu through har...')
 
Line 25: Line 25:
 
| '''Argument''' || '''In/Out''' || '''Description'''
 
| '''Argument''' || '''In/Out''' || '''Description'''
 
|-
 
|-
| ARGS || I || The skillmenu's defname.
+
| ARGS || I || The skillmenu's defname. This is expected to be one of the following:
 +
* sm_alchemy
 +
* sm_blacksmith
 +
* sm_bolts
 +
* sm_bowcraft
 +
* sm_carpentry
 +
* sm_cartography
 +
* sm_inscription
 +
* sm_polymorph
 +
* sm_summon
 +
* sm_tailor_cloth
 +
* sm_tailor_leather
 +
* sm_tinker
 
|}
 
|}
  

Revision as of 20:06, 14 June 2009

Description

This trigger fires when a skill menu is displayed to a player. Note that the trigger only fires when Sphere attempts to display the menu through hardcoded behaviour, using the SKILLMENU command will not cause this trigger to fire.


Fires on:


References

The following object references are explicitly available for this trigger:

Name Description
I The player who the menu is being shown to.
SRC The player who the menu is being shown to.


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
ARGS I The skillmenu's defname. This is expected to be one of the following:
  • sm_alchemy
  • sm_blacksmith
  • sm_bolts
  • sm_bowcraft
  • sm_carpentry
  • sm_cartography
  • sm_inscription
  • sm_polymorph
  • sm_summon
  • sm_tailor_cloth
  • sm_tailor_leather
  • sm_tinker


Return Values

The following return values are explicitly defined for this trigger:

Return Value Description
1 Prevents the skillmenu from being displayed.