Modding:ItemSet - Revision history

Game Hunter: anchor fixes

2012-01-27T23:52:13Z

anchor fixes

Game Hunter: sid fix

2012-01-27T22:38:04Z

sid fix

Game Hunter: wow that was fast

2012-01-27T20:29:43Z

wow that was fast

New page

Along with [[Modding:Item|items]] are the possibility to form sets with certain items. These are formed with the ItemSet object and can be created to produce unique possibilities with gear.

== Prototype==
The ItemSet prototype is fairly small, because almost all of the importance of an item set lies in its engine hooks. The prototype keys are merely there to make sure that such hooks are trigger at the appropriate time.
{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
! colspan="3" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''ItemSet Prototype'''
{{Table3Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=vertical-align:top; padding:0px 2px;
|c3=padding:0px 2px;
|'''string'''|name|This is the item's name. Currently it has no use.
|'''string'''|id|This is the item's sid. It must be distinct from other string ids.
|'''integer'''|trigger|This value determines how many items must be equipped before the set bonus can be added.
|}}
|}

== Engine Hooks ==
ItemSet hooks are not always triggered: instead, they rely on the number of set items currently equipped.
{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|ItemSet Hooks
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|'''void'''|[[#itemset_OnEquip|OnEquip]]([[Modding:Item|Item]] self, [[Modding:Being|Being]] equipper)
|'''void'''|[[#itemset_OnRemove|OnRemove]]([[Modding:Item|Item]] self, [[Modding:Being|Being]] wearer)
|}}
|}

----
{{Anchor|item_OnEquip}}
;OnEquip([[Modding:Item|Item]] self, [[Modding:Being|Being]] equipper)
:This hook is called when the item is equipped in any equipment slot. It is only added to items of the item set if ''trigger''-1 items have already been equipped (that is, all set items but one).
----
{{Anchor|item_OnRemove}}
;OnRemove([[Modding:Item|Item]] self, [[Modding:Being|Being]] wearer)
:This hook is called when a being unequips the item, or when the item is otherwise removed from the being's equipment. This includes armor being destroyed by damage. It is only added to items of the item set if ''trigger'' items have been equipped (that is, the entire set).

@@ Line 11: / Line 11: @@
    |c3=padding:0px 2px;
    |'''string'''|<u>name</u>|This is the item's name. Currently it has no use.
-   |'''string'''|<u>id</u>|This is the item's sid. It must be distinct from other string ids.
+   |'''string'''|id|This is the item's sid. It must be distinct from other string ids. (The numeric id is automatically generated and stored in the nid field of the prototype.) It defaults to the first word of the name in all lowercase.
    |'''integer'''|<u>trigger</u>|This value determines how many items must be equipped before the set bonus can be added.
    |}}

@@ Line 30: / Line 30: @@
 ----
-{{Anchor|item_OnEquip}}
+{{Anchor|itemset_OnEquip}}
 ;OnEquip([[Modding:Item|Item]] self, [[Modding:Being|Being]] equipper)
 :This hook is called when the item is equipped in any equipment slot. It is only added to items of the item set if ''trigger''-1 items have already been equipped (that is, all set items but one).
 ----
-{{Anchor|item_OnRemove}}
+{{Anchor|itemset_OnRemove}}
 ;OnRemove([[Modding:Item|Item]] self, [[Modding:Being|Being]] wearer)
 :This hook is called when a being unequips the item, or when the item is otherwise removed from the being's equipment. This includes armor being destroyed by damage. It is only added to items of the item set if ''trigger'' items have been equipped (that is, the entire set).