Board Space Event Component: Difference between revisions
m (Fixed link) |
m (→How to Use: Made clear that this only works on custom board spaces) |
||
| Line 3: | Line 3: | ||
=== How to Use === | === How to Use === | ||
[[File:BoardSpaceEventComponentExample.png|thumb|600px|right|This custom board space prefab has a board space event component added to the root gameobject in the prefab hierarchy. This will fire when this prefab is used by a custom board space.]] | [[File:BoardSpaceEventComponentExample.png|thumb|600px|right|This custom board space prefab has a board space event component added to the root gameobject in the prefab hierarchy. This will fire when this prefab is used by a custom board space.]] | ||
'''This component currently only works on a [[Custom Board Space]]. It will not work when added to a board space using a built-in board space type.''' | |||
This component should be placed on the '''root gameobject of a prefab''' that is used as a custom board space. Attaching it to the prefab instance, or to a board node in the scene, will not callow the actions to fire. | This component should be placed on the '''root gameobject of a prefab''' that is used as a custom board space. Attaching it to the prefab instance, or to a board node in the scene, will not callow the actions to fire. | ||
When attached to any other gameobject it will do nothing. | When attached to any other gameobject it will do nothing. | ||
== Component Settings == | == Component Settings == | ||
Revision as of 21:32, 11 December 2022
The board space event component is a gameplay component that allows a set of Actions to be performed whenever a player lands on a board mode. It is only usable in Board Mods. The player must finish their turn on the board space for the actions to run; walking over the space will not run the actions.
How to Use
This component currently only works on a Custom Board Space. It will not work when added to a board space using a built-in board space type.
This component should be placed on the root gameobject of a prefab that is used as a custom board space. Attaching it to the prefab instance, or to a board node in the scene, will not callow the actions to fire.
When attached to any other gameobject it will do nothing.
Component Settings
| Property | Description |
|---|---|
| On Enter | A set of Actions to perform whenever a player lands on this space. |
Example Usage
To make unique custom board spaces, you can use this component to affect the player in many ways. See the list of actions to get an idea of what actions can be performed. Note that not all actions are usable on board mods.