Modding:Affects - Revision history

Game Hunter: used more effective templates

2012-03-24T22:02:48Z

used more effective templates

Shark20061: Consistancy...

2012-03-24T17:11:20Z

Consistancy...

Shark20061: Forgot to change the title of table 2.

2012-03-24T17:10:38Z

Forgot to change the title of table 2.

Shark20061: Creating page with what I have figured out. Warning, information is not guaranteed to be completely correct!

2012-03-24T17:09:51Z

Creating page with what I have figured out. Warning, information is not guaranteed to be completely correct!

New page

These represent the various temporary effects in the game.

== Prototype ==

{|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"|'''Affect Prototype'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|'''string''' id | The identifier for the affect.
|'''string''' name | What is displayed in the status line while the effect is active.
|'''[[Modding:Constants#Colors|Color]]''' color | The color of the name on the status line while the effect is on.
|'''[[Modding:Constants#Colors|Color]]''' color_expire | The color of the name on the status line when the effect is wearing off.
|'''string''' message_init | The message printed when the effect is activated.
|'''string''' message_ending | The message printed when the effect is wearing off. This is unused in 0.9.9.6.
|'''string''' message_done | The message printed when the effect wears off.
|'''[[Modding:Constants#StatusEffect|StatusEffect]]''' status_effect | The overlay effect that occurs while this effect is active.
|'''integer''' status_strength | When multiple effects have overlay changes, the one with the highest strength will be the overlay displayed if more than one is active at the same time.
}}
|}

== Engine Hooks ==

{|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"|'''Affect Prototype'''
{{Table2Col
|es=background: #333;
|c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
|c2=padding:0px 2px;
|'''void''' | [[#OnAdd|OnAdd]]('''Affect''' self)
|'''void''' | [[#OnTick|OnTick]]('''Affect''' self)
|'''void''' | [[#OnRemove|OnRemove]]('''Affect''' self)
}}
|}

{{anchor|OnAdd}}
;OnAdd('''Affect''' self)
:This is called when the effect is gained.
----
{{anchor|OnTick}}
;OnTick('''Affect''' self)
:This is called every action while the effect is active.
----
{{anchor|OnRemove}}
;OnRemove('''Affect''' self)
:This is called when the effect is lost.

@@ Line 3: / Line 3: @@
 == Prototype ==
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{{drltable|Affect Prototype|3|{{Table3Col
- ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Affect Prototype'''
- {{Table2Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
-   |c2=padding:0px 2px;
+   |c2=vertical-align:top; padding:0px 2px;
-   |'''string''' id                            | The identifier for the affect.
+   |c3=padding:0px 2px;
-   |'''string''' name                          | What is displayed in the status line while the effect is active.
+  |{{modarg|string}}      |id             |The identifier for the affect.
-   |'''[[Modding:Constants#Colors|Color]]''' color   | The color of the name on the status line while the effect is on.
+   |{{modarg|string}}      |name           |What is displayed in the status line while the effect is active.
-   |'''[[Modding:Constants#Colors|Color]]''' color_expire  | The color of the name on the status line when the effect is wearing off.
+   |{{modarg|Color}}       |color          |The color of the name on the status line while the effect is on.
-   |'''string''' message_init                  | The message printed when the effect is activated.
+   |{{modarg|Color}}       |color_expire   |The color of the name on the status line when the effect is wearing off.
-   |'''string''' message_ending                | The message printed when the effect is wearing off.  This is unused in 0.9.9.6.
+   |{{modarg|string}}      |message_init   |The message printed when the effect is activated.
-   |'''string''' message_done                  | The message printed when the effect wears off.
+   |{{modarg|string}}      |message_ending |The message printed when the effect is wearing off.  This is unused in 0.9.9.6.
-   |'''[[Modding:Constants#StatusEffect|StatusEffect]]''' status_effect | The overlay effect that occurs while this effect is active.
+   |{{modarg|string}}      |message_done   |The message printed when the effect wears off.
-   |'''integer''' status_strength              | When multiple effects have overlay changes, the one with the highest strength will be the overlay displayed if more than one is active at the same time.
+   |{{modarg|StatusEffect}}|status_effect  |The overlay effect that occurs while this effect is active.
    }}
-|}
+}}
 == Engine Hooks ==
-{|class="wikitable" style="border: 2px solid darkred; border-spacing: 0; font-size: 90%; margin: 0.25em 0.5em;"
+{{drltable|Affect Hooks|2|{{Table2Col
- ! colspan="2" style="background: darkred; color: yellow; font-size: 120%; text-align: center"|'''Affect Hooks'''
- {{Table2Col
    |es=background: #333;
    |c1=font-weight:bold; text-align:right; vertical-align:top; padding:0px 2px;
    |c2=padding:0px 2px;
-   |'''void''' | [[#OnAdd|OnAdd]]('''Affect''' self)
+   |{{modarg|void}}|[[#OnAdd|OnAdd]]('''Affect''' self)
-   |'''void''' | [[#OnTick|OnTick]]('''Affect''' self)
+   |{{modarg|void}}|[[#OnTick|OnTick]]('''Affect''' self)
-   |'''void''' | [[#OnRemove|OnRemove]]('''Affect''' self)
+   |{{modarg|void}}|[[#OnRemove|OnRemove]]('''Affect''' self)
    }}
-|}
+}}
 {{anchor|OnAdd}}