Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • C core
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Issues 81
    • Issues 81
    • List
    • Boards
    • Service Desk
    • Milestones
  • Monitor
    • Monitor
    • Incidents
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • Value stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • dulst
  • core
  • Wiki
  • Effect builder
  • Custom Action

Custom Action · Changes

Page history
Update Custom Action authored Aug 30, 2019 by Kaoru Aoi's avatar Kaoru Aoi
Hide whitespace changes
Inline Side-by-side
Effect-Builder/Custom-Action.md
View page @ a5a3247f
......@@ -30,9 +30,12 @@ Prevent the custom action from showing up in any types other than the type reque
Prevent the custom action from showing up in the type requested.
**hiddenFields**
Enter a comma separated list of target fields to hide from the designer when they're using this action. These fields would be fields that generally do not work with that action. Hiding them here can make the UI more intuitive.
Working with custom actions
===========================
......@@ -42,10 +45,8 @@ 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.
......@@ -60,8 +61,7 @@ References the number of cards field.
$**\_targetProperty**
References any property selected, works with cardProperty, playerProperty, or gameProperty.
References any property selected, works with `cardProperty`, `playerProperty`, or `gameProperty`.
$**\_targetValue**
......@@ -71,36 +71,29 @@ $**\_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`.
These custom actions can be later referenced by the field name. Examples: $\_magnitude, $\_player, $\_location.
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.
![](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.
Custom Parameters
-----------------
......
Clone repository
  • Analytics Events
  • Animations
  • Basic Effect Building
  • Change Log v13
  • Change Log v14
  • Change Log v15
  • Change Log v16.1
  • Change Log v16.2
  • Change Log v16.3
  • Change Log v16.4
  • Change Log v16.5
  • Change Log v16.6
  • Change Log v16.7
  • Change Log v16.8
  • Change Log v16
View All Pages