Template:IOEffectProc/doc: Difference between revisions
(creating documentation) |
m (adding documentation) |
||
Line 3: | Line 3: | ||
==Usage== | ==Usage== | ||
This template requires two parameters. It must have one of the following parameters: | |||
*'''custom''' for procs with custom text that does not fit either the '''other''' or '''damage''' format | |||
*'''other''' for procs that provide a chance to effect a target in a way other than damage | |||
*'''damage''' for procs that provide a change to inflict damage on a target | |||
It must also have the '''ppm''' parameter to specify the approximate number of procs per minute. | |||
An optional parameter '''chancemod''' may be provided if the enhancement text specifies a modifier (such as 'minor') for the proc chance. | |||
---- | |||
A custom proc coded as below: | |||
:<code><nowiki>{{IOEffectProc|custom=a chance to reduce your target's damage resistance by 20%|ppm=3.5}}</nowiki></code> | |||
will appear as: | |||
{{IOEffectProc|custom=a chance to reduce your target's damage resistance by 20%|ppm=3.5}} | |||
---- | |||
An 'other' proc which includes a chance modifier coded as below: | |||
:<code><nowiki>{{IOEffectProc|chancemod=minor|other=knock down|ppm=1}}</nowiki></code> | |||
will appear as: | |||
{{IOEffectProc|chancemod=minor|other=knock down|ppm=1}} | |||
---- | |||
A damage proc coded as below: | |||
:<code><nowiki>{{IOEffectProc|damage=minor negative energy|ppm=3}}</nowiki></code> | |||
will appear as: | |||
{{IOEffectProc|damage=minor negative energy|ppm=3}} | |||
==See also== | ==See also== | ||
Revision as of 01:41, 18 September 2020
Usage
This template requires two parameters. It must have one of the following parameters:
- custom for procs with custom text that does not fit either the other or damage format
- other for procs that provide a chance to effect a target in a way other than damage
- damage for procs that provide a change to inflict damage on a target
It must also have the ppm parameter to specify the approximate number of procs per minute.
An optional parameter chancemod may be provided if the enhancement text specifies a modifier (such as 'minor') for the proc chance.
A custom proc coded as below:
{{IOEffectProc|custom=a chance to reduce your target's damage resistance by 20%|ppm=3.5}}
will appear as:
This enhancement adds a chance to reduce your target's damage resistance by 20%. This effect will trigger approximately 3.5 times per minute. Its minimum proc chance is 10.25%, and its maximum is 90%.
An 'other' proc which includes a chance modifier coded as below:
{{IOEffectProc|chancemod=minor|other=knock down|ppm=1}}
will appear as:
This enhancement adds a minor chance to knock down your target(s). This effect will trigger approximately 1 time per minute. Its minimum proc chance is 6.5%, and its maximum is 90%.
A damage proc coded as below:
{{IOEffectProc|damage=minor negative energy|ppm=3}}
will appear as:
This enhancement adds a chance to inflict minor negative energy damage upon your target(s). This effect will trigger approximately 3 times per minute. Its minimum proc chance is 9.5%, and its maximum is 90%.