Board Space Component

From Pummel Party Mod Documentation
Revision as of 03:27, 27 October 2022 by RBDev (talk | contribs) (Added component settings and example usage)
Jump to navigation Jump to search

The board space component is a gameplay component that creates a board space and its connections to other board spaces in a Board Mod.

This component cannot be added through the inspector and instead must be created from the Hierarchy Window by right clicking or from the GameObject toolbar menu. It is created by choosing Board Object > Board Space. This will create a gameobject with a board space component.

Gameobjects with a board space component cannot have any child gameobjects, and will appear a unique color in the hierarchy.

Connecting board nodes

Board nodes can be connected by using the blue arrow gizmos that appear beside them in the Scene View. Gizmos must be enabled for these arrows to appear. If you can't see them, make sure the Gizmos button (Flag icon) is green.

Find a board space you want to create a connection from and click its blue arrow to begin creating a connection. This will display a connection from the board to your cursor. To connect this node to another existing board node, click the destination board node and the connection will be created from the origin to the destination. If you want the connection to flow in the opposite direction, start the connection from the opposite node.

If you click anywhere that isn't a board node while creating a connection, a new board node will be created and connected.

If you want to stop creation of a new connection, right click to cancel without making a connection or placing a new board node.

Connections between board nodes can be deleted by selecting the connection in the scene view and hitting the DELETE key on the keyboard.

Component Settings

Property Description
Type The type of board node.
Custom Node Type
(Only for Type of "Custom")
If Type is set to custom, this input allows you to choose which custom node to use. The list will be empty by default; add options through the board's Mod Settings.
Custom Goal Spawn Should the location of the goal chest and weapons cache be set manually for this board node. If false, the game will choose the best spot based on where other board nodes and connection are. Not available for Pathing and Graveyard spaces, as those cannot have the chest/weapons cache.
Spawn Rotation The direction around the board node to spawn the chest/weapons cache at.
Spawn Distance The distance from the board node to spawn the chest/weapons cache.

For each connection on a board space, you can set the transition used to move players along that connection. Walk is the default and makes the player walk between the spaces, while Teleport will hide the path and teleport the player instantly between the nodes.

An Align to ground button is available to orient the board node flush with the ground beneath it.

Example Usage

Board spaces are the most important aspect of making a board mod. See the Your First Board Map page for guidance on creating a board mod. Board spaces must have at least one connection coming into them and at least one connection going out. The exception to this is Graveyard spaces; these do not need an incoming connection.

There is no limit to the number of incoming or outgoing connections to/from a board space, however do keep in mind that players might have difficulty selecting the right connection if you have too many outgoing connections from a single board space.

Custom board spaces are a slightly more advanced feature, but they can help make a board unique.