Skip to content

GitLab

Custom Action · Changes

Page history
Update Custom Action authored by Kaoru Aoi's avatar Kaoru Aoi
Hide whitespace changes
Inline Side-by-side
Effect-Builder/Custom-Action.md
View page @ 3d914efe
......@@ -12,34 +12,25 @@ If you think of an effect as a sentence, actions are the verb of the sentence.
There are 2 types of actions, built-in dulst [[actions]] and Custom Actions. Built in dulst [[actions]] are at the bottom of the list and do basic things. Custom actions are built from basic actions and usually combine multiple basic actions into one more powerful custom action. All dulst templates, including [[Animal Kingdom]], come with a bunch of custom actions already created.
**Custom Action Settings**
--------------------------
There are a handful of possible custom action settings you may put into the Custom Card Properties field.
**displayName**
Instead of showing the title of the card in the effect builder, set a displayName instead.
**reqType**
Prevent the custom action from showing up in any types other than the type requested.
**excludeType**
Prevent the custom action from showing up in the type requested.
......@@ -51,51 +42,38 @@ Letting the card designer control the action
While many custom actions are pretty simple, letting card designers to just select it and go, some will want the designer to select options.
The targeting column selections the card designer makes when using the custom action is known by the custom action. You can access the selections with variables.
$**\_targetCards**
References the selected cards if applicable.
$**\_target**
References the overall target. This can be a player such as "player1" or "player2". This can be "game". This can be selected cards, same as **\_targetCards**.
$**\_targetCount**
References the number of cards field.
$**\_targetProperty**
References any property selected, works with cardProperty, playerProperty, or gameProperty.
$**\_targetValue**
References the value selected.
$**\_targetInstructions**
References instructions given to players when selecting cards.
To give card designers the ability to make choices in the action column use the action parameters under rule card triggers to let card designers have the same access to option fields in your custom action as you would have in base actions.
These custom actions can be later referenced by the field name. Examples: $\_magnitude, $\_player, $\_location.
......@@ -106,24 +84,18 @@ Setting defaults
Defaults can be set in the custom card properties. When a card uses a custom action, it will overwrite the default if there is an argument passed on a card. If there is not, then the default will be used.
In this example, which is the ["add card to hand" custom action Rule card from Animal Kingdom](https://dulst.com/neoanimalkingdom/cards/6087264/add-card-to-hand), the number of cards is set by the variable $\_targetCount.
![](https://ddx5i92cqts4o.cloudfront.net/images/1clbpkigh_Screen_Shot_2018-08-20_at_9.43.11_AM.png)
\_targetCount is set as 1 on the card itself.
_targetCount is set as 1 on the card itself.
![](https://ddx5i92cqts4o.cloudfront.net/images/1clbpml91_Screen_Shot_2018-08-20_at_9.43.38_AM.png)
This makes 1 the default for this action instead of undefined, allowing the card designer to not put anything in this field if they wish.
......@@ -135,25 +107,15 @@ Custom Parameters
Custom parameters can be defined on the custom card properties section of the card editor. They require these settings:
param_id param_[paramID]_label
param_[paramID]_tooltip
If no options are set, then this will produce a regular text field. You can access the param with $\[\_paramId\]
param_[paramID]_radio
Radio property makes it so that only 1 option may be selected at a time. Don't set this property to allow unlimited selections.
You may also choose to to show some options:
param_[paramID]_option_id
......