From 4253b6a46c56590860bdf1fd51e26ddbd1fb14c3 Mon Sep 17 00:00:00 2001 From: Chris Date: Tue, 24 Oct 2023 01:19:12 -0700 Subject: [PATCH] Update Template Effect.md --- docs/Template Effect.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/Template Effect.md b/docs/Template Effect.md index 590063e90..960978b3f 100644 --- a/docs/Template Effect.md +++ b/docs/Template Effect.md @@ -1,16 +1,16 @@ Creating a template that applies effects is done via specific flags set on a template. -`flags.chris-premades.template.NAME.name` - Internal name of the template effect, used to prevent effects from doubling up in the case of overlapping template effects. Required. -`flags.chris-premades.template.NAME.castLevel` - Cast level of the template effect. Used to help pick the "best" effect when template effects overlap. Optional. -`flags.chris-premades.template.NAME.saveDC` - Save DC of the template effect. Used to help pick the "best" effect when template effects overlap. Optional. -`flags.chris-premades.template.NAME.turn` - Should the effect trigger at the start or end of a combat turn. Valid types are: "start" and "end". Optional. -`flags.chris-premades.template.NAME.ignoreMove` - Don't trigger this effect when the token moves. Must be true or false. Optional. -`flags.chris-premades.template.NAME.templateUuid` - The uuid of the template. Required. -`flags.chris-premades.template.NAME.worldMacro` - The world macro that is called when a token becomes a valid target of the template effect. Required if not using global function. -`flags.chris-premades.template.NAME.globalFunction` - A global function that is called when a token becomes a valid target of the template effect. Required if not using a world macro. -`flags.chris-premades.template.NAME.macroName` - Used by CPR for hard-coded effect templates. You should never need to use this normally. +`flags.chris-premades.template.name` - Internal name of the template effect, used to prevent effects from doubling up in the case of overlapping template effects. Required. +`flags.chris-premades.template.castLevel` - Cast level of the template effect. Used to help pick the "best" effect when template effects overlap. Optional. +`flags.chris-premades.template.saveDC` - Save DC of the template effect. Used to help pick the "best" effect when template effects overlap. Optional. +`flags.chris-premades.template.turn` - Should the effect trigger at the start or end of a combat turn. Valid types are: "start" and "end". Optional. +`flags.chris-premades.template.ignoreMove` - Don't trigger this effect when the token moves. Must be true or false. Optional. +`flags.chris-premades.template.templateUuid` - The uuid of the template. Required. +`flags.chris-premades.template.worldMacro` - The world macro that is called when a token becomes a valid target of the template effect. Required if not using global function. +`flags.chris-premades.template.globalFunction` - A global function that is called when a token becomes a valid target of the template effect. Required if not using a world macro. +`flags.chris-premades.template.macroName` - Used by CPR for hard-coded effect templates. You should never need to use this normally. The world macro or global function is called by CPR with the following arguments: `token` The token that the template effect is targeting. `triggerData` Contains the passed in information from the above flags. With this you can handle creating and removing effects as needed by your template effect. -[Cloudkill](https://github.com/chrisk123999/chris-premades/blob/master/scripts/macros/spells/cloudkill.js) is a good example of how to implement your own template effect. \ No newline at end of file +[Cloudkill](https://github.com/chrisk123999/chris-premades/blob/master/scripts/macros/spells/cloudkill.js) is a good example of how to implement your own template effect.