Trusted Macro: Difference between revisions
Verisimilar (talk | contribs) m (Macros:TrustedMacros moved to Trusted Macro) |
Verisimilar (talk | contribs) (Small rewrite, could still use a little work.) |
||
| Line 1: | Line 1: | ||
Trusted | A Trusted Macro is a macro that fits certain criteria, allowing it access to [[:Category:Macro Function|functions]] and [[:Category:Roll Option|roll options]] that are protected from normal use. | ||
[[:Category:Macro Function|Functions]] and [[:Category:Roll Option|roll options]] that require a Trusted Macro will have the following note on their article: | |||
{{TrustedFunction}} | |||
Using trusted macros can, for example, allow gamemasters to set up macros on [[Token | In order for a macro to be trusted it must adhere to two requirements. If a macro is typed into the chat window, and not attached to a macro button, the only requirement is that the GM is the person who typed the macro. | ||
===First Requirement=== | |||
A trusted macro must not be editable by players. Allowing players to edit trusted macros is tantamount to making all of their macros trusted. To make it so players cannot edit a macro, you must uncheck the ''Allow Players to Edit Macro'' checkbox on the ''Options'' tab of the macro window. This setting defaults to being checked, allowing players access to edit any macro. | |||
[[Image:trustedMacro1.jpg]] | |||
===Second Requirement=== | |||
After satisfying the first requirement, the second requirement can be satisfied in two ways: | |||
* Clicking the macro button as a GM. | |||
* Placing the macro on a [[Library Token|library token]] and having a player call it using a [[:Category:Roll Option|roll option]] or [[macroLink|macro link]]. | |||
===Why trusted macros?=== | |||
Using trusted macros can, for example, allow gamemasters to set up macros on [[Library Token|library tokens]] that can be called by players, but edited only by GMs, and which can access functions that players would not normally be able to access. Such macros can use trusted-only options or functions (such as the [[token (roll option)|[token():]]] roll option or the [[switchToken|switchToken()]] function) to modify or read values from NPC tokens that players do not own. | |||
Revision as of 00:02, 12 March 2009
A Trusted Macro is a macro that fits certain criteria, allowing it access to functions and roll options that are protected from normal use.
Functions and roll options that require a Trusted Macro will have the following note on their article:
Note: This function can only be used in a Trusted Macro
In order for a macro to be trusted it must adhere to two requirements. If a macro is typed into the chat window, and not attached to a macro button, the only requirement is that the GM is the person who typed the macro.
First Requirement
A trusted macro must not be editable by players. Allowing players to edit trusted macros is tantamount to making all of their macros trusted. To make it so players cannot edit a macro, you must uncheck the Allow Players to Edit Macro checkbox on the Options tab of the macro window. This setting defaults to being checked, allowing players access to edit any macro.
Second Requirement
After satisfying the first requirement, the second requirement can be satisfied in two ways:
- Clicking the macro button as a GM.
- Placing the macro on a library token and having a player call it using a roll option or macro link.
Why trusted macros?
Using trusted macros can, for example, allow gamemasters to set up macros on library tokens that can be called by players, but edited only by GMs, and which can access functions that players would not normally be able to access. Such macros can use trusted-only options or functions (such as the [token():] roll option or the switchToken() function) to modify or read values from NPC tokens that players do not own.