Difference between revisions of "@RegenStat"
(Created page with "==Description== This trigger fires when a character is going to regenerate any stat (Hits,Mana,Stam or Food). Fires on: * Characters ==References== The following object...") |
|||
| Line 47: | Line 47: | ||
| local.StatLimit || I/O || by default=<MaxStat>, allow this stat to pass the limit when regenerating, or limit it lower. | | local.StatLimit || I/O || by default=<MaxStat>, allow this stat to pass the limit when regenerating, or limit it lower. | ||
|} | |} | ||
| + | |||
==Aditional Notes== | ==Aditional Notes== | ||
local.Value: It can be set to negative values, 0 will stop any default action like return 1. By default its set to RegenValStatID (ie: RegenValHits) | local.Value: It can be set to negative values, 0 will stop any default action like return 1. By default its set to RegenValStatID (ie: RegenValHits) | ||
| + | |||
Local.StatLimit: Stats over this value will go down in each tick until they reach their limit. This does not work with food as food shouldn't ignore its limit (0). | Local.StatLimit: Stats over this value will go down in each tick until they reach their limit. This does not work with food as food shouldn't ignore its limit (0). | ||
| + | |||
RegenStat is checked before this trigger but it can be changed inside so the next time the trigger will be fired will correspond to this value, setting it to high values is the only way to simulate a regeneration stop. | RegenStat is checked before this trigger but it can be changed inside so the next time the trigger will be fired will correspond to this value, setting it to high values is the only way to simulate a regeneration stop. | ||
| + | |||
| + | You can see your current points in the current stat using <local.StatLimit> as it retrieve (before you modify it) the current stat value. | ||
| + | |||
==Return Values== | ==Return Values== | ||
Revision as of 10:59, 18 February 2014
Description
This trigger fires when a character is going to regenerate any stat (Hits,Mana,Stam or Food).
Fires on:
References
The following object references are explicitly available for this trigger:
| Name | Description |
| I | The character whose strength, dexterity or intelligence is being changed. |
| SRC | The character whose strength, dexterity or intelligence is being changed. |
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 | ||||||||||||||||
| local.StatID | I/O | The stat being changed.
| ||||||||||||||||
| local.Value | I/O | The amount of points being regenerated (or decreased in food's case). | ||||||||||||||||
| local.StatLimit | I/O | by default=<MaxStat>, allow this stat to pass the limit when regenerating, or limit it lower. |
Aditional Notes
local.Value: It can be set to negative values, 0 will stop any default action like return 1. By default its set to RegenValStatID (ie: RegenValHits)
Local.StatLimit: Stats over this value will go down in each tick until they reach their limit. This does not work with food as food shouldn't ignore its limit (0).
RegenStat is checked before this trigger but it can be changed inside so the next time the trigger will be fired will correspond to this value, setting it to high values is the only way to simulate a regeneration stop.
You can see your current points in the current stat using <local.StatLimit> as it retrieve (before you modify it) the current stat value.
Return Values
The following return values are explicitly defined for this trigger:
| Return Value | Description |
| 1 | Prevents the process to ocur. |
