Difference between revisions of "@NotoSend"
From SphereWiki
(Created page with "==Description== This trigger fires when a character's fame level is about to change. Fires on: * Characters ==References== The following object references are explicit...") |
(→References) |
||
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
==Description== | ==Description== | ||
| − | This trigger fires when a character's | + | This trigger fires when a character's notoriety is being sent on a packet update (its fired a lot of times, keep it light and clean of code). |
Fires on: | Fires on: | ||
* [[Characters]] | * [[Characters]] | ||
| − | |||
==References== | ==References== | ||
| Line 13: | Line 12: | ||
| '''Name''' || '''Description''' | | '''Name''' || '''Description''' | ||
|- | |- | ||
| − | | [[I]] || The [[Characters|character]] whose | + | | [[I]] || The [[Characters|character]] whose noto is changing. |
|- | |- | ||
| − | | [[SRC]] || The [[Characters|character]] | + | | [[SRC]] || The [[Characters|character]] retrieving this character's Notoriety. |
|} | |} | ||
| − | |||
==Arguments== | ==Arguments== | ||
| Line 25: | Line 23: | ||
| '''Argument''' || '''In/Out''' || '''Description''' | | '''Argument''' || '''In/Out''' || '''Description''' | ||
|- | |- | ||
| − | | ARGN1 || IO || The notoriety | + | | ARGN1 || IO || The notoriety value (Limited from 1 to 7, other values are ignored). |
| + | |- | ||
| + | | ARGN2 || IO || The color sent in the character's packet (what is seen in status bar, character's hover, etc). | ||
|} | |} | ||
| + | |||
| + | Notes: | ||
| + | -''The default colors are listed above but you can set any color (note that the colors are not the same as for items/chars from hues.mul).'' | ||
| + | -''Modifying the argn1 value will stop default behaviours checks and make the function 'NotoGetFlag' to return this value.'' | ||
==Notoriety Values== | ==Notoriety Values== | ||
| Line 47: | Line 51: | ||
|- | |- | ||
| NotoInvul || 7 || yellow | | NotoInvul || 7 || yellow | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
==Return Values== | ==Return Values== | ||
| − | + | ''This trigger doesn't have return values, notoriety something that must always be sent.'' | |
| − | |||
| − | |||
| − | ''This trigger doesn't have return values, notoriety must be sent | ||
[[Category: Reference Compendium]] | [[Category: Reference Compendium]] | ||
[[Category: Triggers]] | [[Category: Triggers]] | ||
Latest revision as of 11:58, 2 May 2015
Description
This trigger fires when a character's notoriety is being sent on a packet update (its fired a lot of times, keep it light and clean of code).
Fires on:
References
The following object references are explicitly available for this trigger:
| Name | Description |
| I | The character whose noto is changing. |
| SRC | The character retrieving this character's Notoriety. |
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 |
| ARGN1 | IO | The notoriety value (Limited from 1 to 7, other values are ignored). |
| ARGN2 | IO | The color sent in the character's packet (what is seen in status bar, character's hover, etc). |
Notes:
-The default colors are listed above but you can set any color (note that the colors are not the same as for items/chars from hues.mul). -Modifying the argn1 value will stop default behaviours checks and make the function 'NotoGetFlag' to return this value.
Notoriety Values
These are the default Notoriety Values (also listed in sphere.ini).
| Name | ID | Description |
| NotoGood | 1 | Blue character. |
| NotoGuildSame | 2 | Green character (Ally) |
| NotoNeutral | 3 | grey (can be attacked) |
| NotoCriminal | 4 | grey (criminal) |
| NotoGuildWar | 5 | orange (enemy guild) |
| NotoEvil | 6 | red |
| NotoInvul | 7 | yellow |
Return Values
This trigger doesn't have return values, notoriety something that must always be sent.
