Pummel Party Mod Documentation - User contributions [en]

Set Placement Action

2024-05-28T01:18:46Z

RBAdmin: Update for 1.14.0c

[[File:SetPlacementAction.png|thumb|600px|The Set Placement action in the [[Action Editor]].]]
An action to mark a player as finished and set their placement.

This action works by assigning a different number of points to players based on when this action was run while targeting them. For example, creating a trigger that runs this action on the activating player, then having each player hit the trigger in turn, will cause each player to receive a different number of points based on who hit it first and who hit it last. Combine this with the "Placement Condition" set to ''Finish Order'' in the [[Mod Settings#Minigame Settings|minigame settings]] to stop the minigame once all players have had a placement set.

The number of points given to players is equal to <code>100 * (<number of players> - <number of finished players>)</code>. As an example, in a game with 3 players, the first person to get a placement is given 300 points, the second 200 and the last player gets 100 points. In an 8-player game, the points awarded from first to last place are 800, 700, 600, 500, 400, 300, 200, and 100.

As the points awarded by this action may seem arbitrary, it may be worth hiding the points from the players by disabling the '''Show Points in UI''' option by selecting the Minigame Settings at the top of the Hierarchy window and then finding the option under the Minigame Settings foldout in the Inspector window.

The target must be set to a player, otherwise, the action does nothing.

This action can only be used in [[Minigame Mod]]s.

[[Category:Actions]]

Set Placement Action

2024-05-27T05:05:03Z

RBAdmin: Updated for 1.14.0b

[[File:SetPlacementAction.png|thumb|600px|The Set Placement action in the [[Action Editor]].]]
An action to mark a player as finished and set their placement.

This action works by assigning a different number of points to players based on when this action was run while targeting them. For example, creating a trigger that runs this action on the activating player, then having each player hit the trigger in turn, will cause each player to receive a different number of points based on who hit it first and who hit it last. Combine this with the "Placement Condition" set to ''Finish Order'' in the [[Mod Settings#Minigame Settings|minigame settings]] to stop the minigame once all players have had a placement set.

As of 1.14.0, this action awards <code>(50 * 2^(<number of players> - <number of finished players>))</code> points to each player the action targets. The '2 to the power of...' causes each subsequent finishing player to have half as many points as the previous finished player. This reduces the likelihood of any other points given during the game causing placements to get out of order. In an 8-player game, the points awarded from first to last place will be 12800, 6400, 3200, 1600, 800, 400, 200 and 100.
As the points awarded by this action may seem arbitrary, it may be worth hiding the points from the players by disabling the '''Show Points in UI''' option by selecting the Minigame Settings at the top of the Hierarchy window and then finding the option under the Minigame Settings foldout in the Inspector window.

The target must be set to a player, otherwise, the action does nothing.

This action can only be used in [[Minigame Mod]]s.

== Previous Versions ==

The number of points given to players in 1.13.4 and earlier was equal to <code>100 * (<number of players> - <number of finished players>)</code>. As an example, in a game with 3 players, the first person to get a placement was given 300 points, the second 200 and the last player got 100 points. In an 8-player game, the points awarded from first to last place were 800, 700, 600, 500, 400, 300, 200, and 100.

[[Category:Actions]]

Set Placement Action

2024-05-21T04:57:59Z

RBAdmin:

[[File:SetPlacementAction.png|thumb|600px|The Set Placement action in the [[Action Editor]].]]
An action to mark a player as finished and set their placement.

This action works by assigning a different number of points to players based on when this action was run while targeting them. For example, creating a trigger that runs this action on the activating player, then having each player hit the trigger in turn, will cause each player to receive a different number of points based on who hit it first and who hit it last. Combine this with the "Placement Condition" set to ''Finish Order'' in the [[Mod Settings#Minigame Settings|minigame settings]] to stop the minigame once all players have had a placement set.

As of 1.14.0, this action awards <code>(100 * 2^(<number of players> - <number of finished players>))</code> points to each player the action targets. The '2 to the power of...' causes each subsequent finishing player to have half as many points as the previous finished player. This reduces the likelihood of any other points given during the game causing placements to get out of order. In an 8-player game, the points awarded from first to last place will be 25600, 12800, 6400, 3200, 1600, 800, 400, and 200.
As the points awarded by this action may seem arbitrary, it may be worth hiding the points from the players by disabling the '''Show Points in UI''' option by selecting the Minigame Settings at the top of the Hierarchy window and then finding the option under the Minigame Settings foldout in the Inspector window.

The target must be set to a player, otherwise, the action does nothing.

This action can only be used in [[Minigame Mod]]s.

== Previous Versions ==

The number of points given to players in 1.13.4 and earlier was equal to <code>100 * (<number of players> - <number of finished players>)</code>. As an example, in a game with 3 players, the first person to get a placement was given 300 points, the second 200 and the last player got 100 points. In an 8-player game, the points awarded from first to last place were 800, 700, 600, 500, 400, 300, 200, and 100.

[[Category:Actions]]

Set Placement Action

2024-02-28T22:14:23Z

RBAdmin: Added 1.14.0 placement info

[[File:SetPlacementAction.png|thumb|600px|The Set Placement action in the [[Action Editor]].]]
An action to mark a player as finished and set their placement.

This action works by assigning a different number of points to players based on when this action was run while targeting them. For example, creating a trigger that runs this action on the activating player, then having each player hit the trigger in turn, will cause each player to receive a different number of points based on who hit it first and who hit it last. Combine this with the "Placement Condition" set to ''Finish Order'' in the [[Mod Settings#Minigame Settings|minigame settings]] to stop the minigame once all players have had a placement set.

The number of points given to players in 1.13.4 is equal to <code>100 * (<number of players> - <number of finished players>)</code>. As an example, in a game with 3 players, the first person to get a placement will be given 300 points, the second 200 and the last player gets 100 points. In an 8-player game, the points awarded from first to last place will be 800, 700, 600, 500, 400, 300, 200, and 100.

As of 1.14.0 this will be changed to <code>(100 * 2^(<number of players> - <number of finished players>))</code> points. The '2 to the power of...' causes each subsequent finishing player to have half as many points as the previous finished player. This reduces the likelihood of any other points given during the game causing placements to get out of order. In an 8-player game, the points awarded from first to last place will be 25600, 12800, 6400, 3200, 1600, 800, 400, and 200.
As the points awarded by this action may seem arbitrary, it may be worth hiding the points from the players by disabling the '''Show Points in UI''' option by selecting the Minigame Settings at the top of the Hierarchy window then finding the option under the Minigame Settings foldout in the Inspector window. This setting is also new to 1.14.0.

The target must be set to a player, otherwise, the action does nothing.

This action can only be used in [[Minigame Mod]]s.

[[Category:Actions]]

Set Placement Action

2024-01-29T21:25:39Z

RBAdmin: Added more useful information

Give Trophy Action

2023-12-17T20:48:39Z

RBAdmin: Remove future content notice

[[File:GiveTrophyAction.png|thumb|600px|The Give Trophy action in the [[Action Editor]].]]
An action to give a player a trophy. This action can target players on multiple board spaces by using the ''Advanced'' '''Targets''' option.

The action can give one or more trophies to the targeted player(s). The maximum number of trophies that can be given at once is 20.

The ''Play Fanfare Sound'' option will play a cheering/victory sound for the player when they receive the trophy. Without this enabled, the trophy will still be shown but the sound will not play.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

To remove trophies, use the [[Remove Trophy Action]].

[[Category:Actions]]

Board Space Component

2023-12-17T20:47:29Z

RBAdmin: /* Component Settings */ Added rocket dismount option info

The board space component is a [[:Category:Gameplay Components|gameplay component]] that creates a board space and its connections to other board spaces in a [[Board Mod]].

Board space components cannot be added to gameobjects that have child gameobjects in the hierarchy. They also cannot be used within prefabs.
Gameobjects with a board space component cannot have any child gameobjects added. They are given a unique icon and color in the hierarchy.

== Connecting Board Spaces ==
Board spaces 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 space to another existing board space, click the destination board spaces 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 space.

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

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

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

==Board Space Types==
[[File:BoardSpaceTypes.png|thumb|right|600px|The 8 different board space types, not including custom spaces.]]
There are eight types of board spaces provided, plus the Custom type which lets you select your own [[Custom Board Space]].
===Pathing Space===
This board space is invisible. It can take connections in and have connections out to other board spaces. Players cannot land on this space and passing one doesn't cost a step. Use these spaces to create more advanced paths between visible spaces, rather than a straight-line connection.
===Start Space===
This space is where the game will start. All players spawn on the start space. There must be exactly one start space per board mod. Nothing happens when landing on a start space.
===Heal Space===
The heal space will heal any player that lands on it by 10 health points.
===Gold Space===
The gold space rewards the player that landed on it with 5 keys.
===Hazard Space===
Landing on a hazard space will deal 5 health points of damage to the player.
===Item Space===
The item space gives any player who lands on it a single item. This item can be any item excluding the Dark Summoning Staff, Arcade Machine, Giga Laser and Nuke Barrel (these are only available from the weapons cache).

===Recruit Space===
The first player to land on a recruit space can claim the space. They can decide between having the reaper:
* steal 9-12 health, damaging the player and healing the space owner.
* steal 6 keys, taking them from the player and giving them to the space owner.
When claiming a recruit space, all connected recruit spaces will also be claimed.
===Graveyard Space===
The graveyard space is a special space that is used when a player dies. You should include at least one graveyard space in a map for players to respawn at. Without this, players will respawn at the Start space. If there are multiple graveyards the player is respawned at the one furthest away from the trophy chest. Graveyard spaces cannot have incoming connections, only outgoing connections meant to put the player back onto the board.

===Custom Space===
You can create [[Custom Board Space|custom board spaces]] using prefabs. This is a slightly more advanced feature, but it can help make a board unique. These spaces use a set of [[Action]]s in a [[Board Space Event Component]] to define what happens when players land on them.

== Component Settings ==
[[File:BoardSpaceComponent.png|thumb|right|500px|The Board Space component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Type''' || The type of board space.
|-
| style="padding-left: 2em;" | '''Custom Space Prefab'''<br />''(Only for Type of "Custom")'' || The prefab that is used for this [[Custom Board Space]]. The list will be empty by default; add options through the board's [[Mod Settings]].
|-
| '''Supports Goal''' || If this board space is allowed to spawn the trophy chest or weapon cache.
|-
|'''Custom Goal Position''' || Should the location of the goal chest and weapons cache be set manually for this board space. If false, the game will choose the best spot based on the location and direction of other board spaces and connections. Not available for ''Pathing'' and ''Graveyard'' spaces, or when ''Supports Goal'' is false as these spaces cannot spawn the chest/weapons cache.
|-
| style="padding-left: 2em;" | '''Spawn Rotation''' || The direction around the board space to spawn the chest/weapons cache at.
|-
| style="padding-left: 2em;" | '''Spawn Distance''' || The distance from the board space to spawn the chest/weapons cache.
|-
| '''Can be landed on'''<br />''(Only for Type of "Custom")'' || Set whether or not this custom board space can be landed on by players. In other words, does it cost a step to walk over this space. Disabling this will cause players to pass over the space without costing a step, meaning they can never end their turn on this space. They will still run the On Player Passing event of a [[Board Space Event Component]] as they pass over the space.
|-
| '''Stop Rocket from entering'''<br />''(Only for Type of "Custom")'' || If a player is riding a rocket skewer item and approaches this space, they will dismount to rocket on the space before this one. This forces them to walk over this space, never fly over it.
|-
|'''Start Disabled''' || When enabled, the board space will be disabled at the start of a game. It can be re-enabled during the game by using a [[Set Board Space Active Action]].
|-
|'''Outgoing Connections''' || A list of all connections leaving this board space. Here you can adjust their transition type.
|-
| style="padding-left: 2em;" | '''Player Transition''' || How the player should move along the connection. There are three options: ''Walk'', ''Jump'' and ''Teleport''.
|-
| style="padding-left: 4em;" | ''Walk'' || The player will walk from one board space to the next. This is the default behaviour.
|-
| style="padding-left: 4em;" | ''Jump'' || The player will perform a quick jumping animation from one board space to the next. This is useful if the board spaces are separated by a gap or are at different elevations.
|-
| style="padding-left: 4em;" | ''Teleport'' || The player will instantly teleport from one board space to the next. This mode hides the path between the spaces.
|-
| style="padding-left: 2em;" | '''Start Disabled''' || When enabled, the connection will be disabled at the start of a game. It can be re-enabled by using a [[Set Connection Active Action]].
|-
|}

An ''Align board space to ground'' button is available to quickly position and rotate the board space so that its centre is placed flush with the ground beneath it.

== Connections ==
[[File:BoardConnectionTypes.png|600px|clear|thumb|The three different connection types and how they appear in the mod editor when enabled and disabled. They are Walk (Left), Jump (Center) and Teleport (Right)]]

Board spaces are connected by connection. Each connection has an origin space, a destination space, a transition type and a direction. The origin space is used to begin the creation of the connection and the destination is used to end the creation. The direction is from the origin to the destination. The transition type of a connection is set once the connection has been created by selecting the origin space and using the [[Inspector Window]].

The Walk transition is the default transition type and causes players to simply walk between each board space.

The Jump transition causes the player to perform a jumping animation from the origin space to the destination space. The Rocket skewer can fly along this type. The Bunny will also perform a jump along this type. This transition type is visually more suited to moving the player between board spaces that are at different elevations or that have a gap between them that doesn't make sense to walk across.

The Teleport transition causes the player to instantly blink from the origin space to the destination space. This type still costs a turn. The rocket skewer item will teleport when it reaches the origin space. The Bunny will also teleport. Teleport connections don't draw the black line between the origin and destination space, so they are suited to moving the player over long distances across the board, or to different areas only accessible via teleporting.

<br clear="all">

== 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.

[[Category:Gameplay Components]]
[[Category:Components]]

Mod Settings

2023-12-17T20:38:46Z

RBAdmin: /* Board Mod Settings */ Added new board settings

When creating a mod there are many general settings that relate to the mod itself, rather than any specific [[Component]] or [[Gameobject]]. These settings are grouped into the special ''Minigame/Board Settings'' gameobject at the top of the [[Hierarchy Window]]. These control important attributes such as the mod's name/description, music/sound, rules, controls, lighting and screen effects.

==General Mod Settings==
===Minigame/Board Details===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Name'''||The name of the mod. This is the name used in-game only.
''Note: To set the name for the Steam Workshop, use the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
| '''Description'''
| The description of the mod as it appears in the:
*Minigame loading screen (minigame mods)
*Multiplayer lobby (board mods)
''Note: This is not the description for the Steam Workshop, that is set in the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
| '''Preview Image''' || The preview image that appears in the:
*Minigame loading screen (minigame mods)
*Multiplayer lobby (board mods)
''Note: This is not the preview image for the Steam Workshop, that is set in the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
|}

===Music & Ambient Sound===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Music''' || The music that plays in the background while playing the minigame or on the board scene. This track will loop.
|-
| style="padding-left: 2em;" | '''Music Volume''' || The volume of the music.
|-
| '''Ambience''' || An ambient track to play in the background. This track will loop.
|-
| style="padding-left: 2em;" | '''Ambience Volume''' || The volume of the ambient track.
|-
|}

===Lighting===
These settings allow the lighting of the entire mod to be adjusted. This can set the tone of the mod, or create interesting effects such as making the mod very dark or setting very unusual lighting.

See [[Lighting Settings]] for the available options.

===Screen Effects===
Screen effects are post-processing style effects that are added to the final view of the scene before it is shown to the player. Screen effects include things like bloom and color correction.

See [[Screen Effects]] for the available options.

==Minigame Mod Settings==

===Minigame Settings ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Rounds''' || The number of rounds to use for the minigame.
|-
| '''End Conditions''' || How the minigame should end.
|-
| style="padding-left: 2em;" | ''Timer'' || The minigame will end after the timer expires.
|-
| style="padding-left: 4em;" | '''Round Duration (s)''' || The duration of a single round in seconds.
|-
| style="padding-left: 2em;" | ''ObtainPoints'' || The minigame will end after a single player has achieved a given number of points.
|-
| style="padding-left: 4em;" | '''Points to win''' || The number of points a single player needs to earn to win the minigame.
|-
| style="padding-left: 2em;" | ''RemainingPlayersAlive'' || The minigame will end when there are only a given number of players left alive.
|-
| style="padding-left: 4em;" | '''Players Alive''' || The number of players left alive for the minigame to end. ''Note: If this is greater than or equal to the number of players in the lobby, it will be set to 1 fewer than the lobby player count. E.g. if Players Alive is 4 but there are only 2 people in the lobby, it will be set to 1 instead of 4.''
|-
| style="padding-left: 2em;" | ''FinishMinigame'' || The minigame will end when all players have had a [[Set Placement Action]] fired for them.
|-
| '''Placement Condition''' || How the players are ordered to determine who came first to who came last.
|-
| style="padding-left: 2em;" | ''Most Points'' || The player with the most points will be first. The player with the fewest points will be last.
|-
| style="padding-left: 2em;" | ''Least Points'' || The player with the fewest points will be first. The player with the most points will be last.
|-
| style="padding-left: 2em;" | ''Finish Order'' || Players are given placements in the order that they finished. This is the order in which their [[Set Placement Action]]s were fired. The player who finished first is given first place.
|-
| style="padding-left: 2em;" | ''Last Man Standing'' || Players are given placements in the order in which they were killed. Players who died first are placed last. With the players who haven't died, or those who died last being placed first.
|-
|}

===Player Settings===
These settings configure how the player moves and interacts with the minigame scene.

{| class="wikitable"
|-
! Property !! Description
|-
| '''Player Type''' || How the player is controlled. Can choose between ''Third Person'' and ''Top Down''.
|}

====Movement====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Movement Speed''' || The maximum speed the player can be made to move using a movement input.
|-
| '''Acceleration''' || How quickly the player accelerates to their ''Movement Speed'' while on the ground.
|-
| '''Deceleration''' || How quickly the player decelerates when not receiving a movement input.
|-
| ''Mid-air Acceleration'' || How quickly the player accelerates to their ''Movement Speed'' while airborne.
|-
| '''Gravity Scale''' || A multiplier that affects the strength of gravity felt by the player.
|-
| ''Max Step Height'' || The maximum height in units that players can walk up without needing to jump.
|-
| '''Can Jump''' || If the player is able to jump or not.
|-
| style="padding-left: 2em;" | '''Jump Speed''' || The power of the player's jump. Larger numbers will result in higher jumps.
|-
| '''Mid-air Jumps''' || How many times the player can jump while in mid-air before they need to touch the ground again.
|-
| '''Twinstick Controls''' || ''(Top Down player type only)'' Should the player use twinstick controls. When enabled, the player's facing direction is controlled separately from the movement direction. When disabled, the player will always face the direction of movement.
|-
|}

====Camera====
Only available if using the Top Down player.
{| class="wikitable"
|-
! Property !! Description
|-
| '''Camera Mode''' || The type of camera to use.
* Static: Remains in one place and never moves.
* Follow: Follow a single player around.
* Follow All: Moves to follow the average position between all players.
|-
| '''Camera Distance''' || How far back the camera is from its target (World origin for ''Static'' camera, Player for ''Follow'' camera, All Player average position for ''Follow All'' camera). The target can be offset using the ''Position Offset'' attribute.
|-
| '''View Angle''' || The camera's angle of elevation from the horizontal plane, in degrees. 0 is looking parallel to the ground. 90 is perpendicularly looking directly down from above.
|-
| '''Position Offset''' || How far back the camera is from its target. The target can be set using the ''Position Offset'' attribute.
|-
| '''Follow Area Shape''' || Should punching another player stun them.
|-
| style="padding-left: 2em;" | ''Square'' || Confines the camera to moving within a rectangular area.
|-
| style="padding-left: 4em;" | '''Left/Right Size''' || Width of the camera area on the X axis.
|-
| style="padding-left: 4em;" | '''Forward/Backward Size''' || Width of the camera area on the Z axis.
|-
| style="padding-left: 4em;" | '''Max X Move Distance''' || The maximum distance the camera can move from the left to the right. I.e. it can move half this distance from the center of the follow area.
|-
| style="padding-left: 4em;" | '''Max Z Move Distance''' || The maximum distance the camera can move forward and backward. I.e. it can move half this distance in both the forward and backward directions from the center of the follow area.
|-
| style="padding-left: 4em;" | '''Centre''' || The center of the follow area on the X/Z plane of the camera follow area.
|-
| style="padding-left: 2em;" | ''Circle'' || Confines the camera to moving within a rectangular area.
|-
| style="padding-left: 4em;" | '''Circle Diameter''' || The diameter of the follow are circle.
|-
| style="padding-left: 4em;" | '''Max Move Distance''' || The maximum distance the camera can move along any axis. I.e. it can move half this distance from the center to its maximum in a given direction.
|-
| style="padding-left: 4em;" | '''Circle Centre''' || The center of the follow area on the X/Z plane of the camera follow area.
|-
|}

====Punching====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Can Punch''' || If the player is able to punch using their fists when not holding an item.
''Note: With this disabled, the player is still able to use melee weapons''.
|-
| style="padding-left: 2em;" | '''Cooldown (s)''' || How long since the start of the last punch (in seconds) must the player wait before they can begin another punch.
|-
| style="padding-left: 2em;" | '''Damage''' || How much damage does each punch deal to other players.
|-
| style="padding-left: 2em;" | '''Punch Stuns Target''' || Should punching another player stun them.
|-
| style="padding-left: 4em;" | '''Punch Stun Duration (s)''' || The duration of the stun inflicted on other players who get punched, in seconds.
|-
|}

====Stuns ====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Immunity Duration''' || The duration in seconds since the last stun in which the player cannot be stunned again. Begins when the last stun finishes.
|-
|}

====Respawning====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Can Respawn''' || If the player should respawn when killed, or remain dead until the end of the round.
|-
| '''Respawn Time (s)''' || The time is seconds between dying and being respawned.
|-
| '''Invulnerable Time (s)''' || The time in seconds after respawning in which the player cannot take any damage.
|-
|}

====Event Triggers====
{| class="wikitable"
|-
! Property !! Description
|-
| '''On Weapon Hit''' || Event fired on the player when they are hit by a weapon.
|-
| style="padding-left: 2em;" | '''Weapon Type''' || The type(s) of weapon that will cause this event to fire.
|-
| '''On Tick''' || Event fired on the player continuously with a given interval.
|-
| style="padding-left: 2em;" | '''Interval''' || How long in seconds between each firing of this event. Can set either a constant value or a random value with lower and upper bounds.
|-
| '''On Death''' || Event that fires each time the player is killed.
|-
| '''On Respawn''' || Event that fires each time the player is respawned. This does not include the first time they are spawned at the beginning of a game or round.
|-
| '''On Round Start''' || Event that fires per player once per round on the initial spawn of the player. <br/>E.g. This will fire at the start of each round if multiple rounds are used, or just once at the start of the game if it only has a single round. Use a [[Logic Component]] ''Round Start'' trigger if you want to run actions that aren't tied to a player.
|-
| '''On Round End''' || Event that fires per player once per round when the round has ended. <br/>E.g. This will fire at the end of every round if multiple rounds are used, or just once at the end of the game if it only has a single round. Use a [[Logic Component]] ''Round End'' trigger if you want to run actions that aren't tied to a player.
|-
|}

==== Health ====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Use Health''' || If the player should use health or not. If not using health, any damage received will instantly kill the player.
|-
| style="padding-left: 2em;" | '''Show Health Bar''' || Whether or not a health bar should be displayed above every player's head.
|-
| style="padding-left: 2em;" | '''Health Points''' || How many health points should the player have.
|-
|}

==== Name Tags====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Name Tag Type''' || What type of player name tags should be used by this minigame? This setting changes how the nametag scales as it moves away from the camera and whether it is displayed in front of or behind objects in the world.
|-
| style="padding-left: 2em;" | ''Screen Space'' || Name tags keep a constant, fixed size on the screen regardless of how far away the player is from the camera. The nametag will appear above everything else in the scene.
|-
| style="padding-left: 2em;" | ''World Space'' || Name tags will shrink as they move farther away from the camera as any object typically would. The nametag will still appear above everything else in the scene however.
|-
| style="padding-left: 2em;" | ''True World Space'' || Name tags will shrink as they move farther away from the camera as any object typically would. The nametag will be occluded by scene objects. '''(Default value)'''
|-
|}

==Board Mod Settings==

=== Board Details ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Trophy Chests''' || The default number of chests to spawn when playing the map. This many chests will be spawned on the board at once unless the player's ruleset is set to override the chest count.
|-
| '''Weapons Cache''' || Can the weapons Cache spawn on this board?
|-
| '''Custom Chest Shuffle Position''' || Enable this to override the position of the Fake Chest modifier's chest shuffle animation. If left disabled, the shuffle will happen above one of the graveyard spaces.
|-
| style="padding-left: 2em;" | '''Chest Shuffle Position''' || An x,y,z position in world space for where the chest shuffle animation will occur. A gizmo will appear in the scene view at this location whenever the board details are visible in the [[Inspector Window]].
|-
|}

=== Custom Spaces===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Custom Space Prefabs''' || A list of prefabs that can be used as custom board spaces. See [[Custom Board Space]] for more information.
|-
|}

=== Board Size ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Use Custom Board Size''' || Enabled the inputs to set a custom board size. If this is disabled, the board size is calculated automatically based on the placement of board spaces in the scene. Only enabled this if you have a need to set the board size manually.
|-
| '''Left/Right Size''' || The width of the board map playable area on the X axis, in units.
|-
| '''Forward/Backward Size''' || The width of the board map playable area on the Z axis, in units.
|-
| '''Map Center''' || The X/Z position of the center of the board map.
|}

=== Camera Settings ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Elevation Angle''' || The angle between the camera's view direction and the X/Z plane, in degrees.
|-
| '''Camera Mode''' || The type of camera view mode to use.
|-
| style="padding-left: 2em;" | ''Perspective'' || View the world with a 3D camera that can show depth and perspective.
|-
| style="padding-left: 4em;" | '''Field of View''' || The vertical field of view of the camera. Higher values result in more objects being seen around the edge of the view.
|-
| style="padding-left: 4em;" | '''Distance''' || The distance to the target from the camera.
|-
| style="padding-left: 2em;" | ''Orthographic'' || View the world with a 2D camera that displays everything at the same depth.
|-
| style="padding-left: 4em;" | '''View Size''' || The size of the camera's view. Technically, this is half the height of the camera view in units.
|-
|}

Mod Settings

2023-12-17T20:31:10Z

RBAdmin: /* Minigame Mod Settings */ Added name tag info

When creating a mod there are many general settings that relate to the mod itself, rather than any specific [[Component]] or [[Gameobject]]. These settings are grouped into the special ''Minigame/Board Settings'' gameobject at the top of the [[Hierarchy Window]]. These control important attributes such as the mod's name/description, music/sound, rules, controls, lighting and screen effects.

==General Mod Settings==
===Minigame/Board Details===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Name'''||The name of the mod. This is the name used in-game only.
''Note: To set the name for the Steam Workshop, use the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
| '''Description'''
| The description of the mod as it appears in the:
*Minigame loading screen (minigame mods)
*Multiplayer lobby (board mods)
''Note: This is not the description for the Steam Workshop, that is set in the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
| '''Preview Image''' || The preview image that appears in the:
*Minigame loading screen (minigame mods)
*Multiplayer lobby (board mods)
''Note: This is not the preview image for the Steam Workshop, that is set in the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
|}

===Music & Ambient Sound===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Music''' || The music that plays in the background while playing the minigame or on the board scene. This track will loop.
|-
| style="padding-left: 2em;" | '''Music Volume''' || The volume of the music.
|-
| '''Ambience''' || An ambient track to play in the background. This track will loop.
|-
| style="padding-left: 2em;" | '''Ambience Volume''' || The volume of the ambient track.
|-
|}

===Lighting===
These settings allow the lighting of the entire mod to be adjusted. This can set the tone of the mod, or create interesting effects such as making the mod very dark or setting very unusual lighting.

See [[Lighting Settings]] for the available options.

===Screen Effects===
Screen effects are post-processing style effects that are added to the final view of the scene before it is shown to the player. Screen effects include things like bloom and color correction.

See [[Screen Effects]] for the available options.

==Minigame Mod Settings==

===Minigame Settings ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Rounds''' || The number of rounds to use for the minigame.
|-
| '''End Conditions''' || How the minigame should end.
|-
| style="padding-left: 2em;" | ''Timer'' || The minigame will end after the timer expires.
|-
| style="padding-left: 4em;" | '''Round Duration (s)''' || The duration of a single round in seconds.
|-
| style="padding-left: 2em;" | ''ObtainPoints'' || The minigame will end after a single player has achieved a given number of points.
|-
| style="padding-left: 4em;" | '''Points to win''' || The number of points a single player needs to earn to win the minigame.
|-
| style="padding-left: 2em;" | ''RemainingPlayersAlive'' || The minigame will end when there are only a given number of players left alive.
|-
| style="padding-left: 4em;" | '''Players Alive''' || The number of players left alive for the minigame to end. ''Note: If this is greater than or equal to the number of players in the lobby, it will be set to 1 fewer than the lobby player count. E.g. if Players Alive is 4 but there are only 2 people in the lobby, it will be set to 1 instead of 4.''
|-
| style="padding-left: 2em;" | ''FinishMinigame'' || The minigame will end when all players have had a [[Set Placement Action]] fired for them.
|-
| '''Placement Condition''' || How the players are ordered to determine who came first to who came last.
|-
| style="padding-left: 2em;" | ''Most Points'' || The player with the most points will be first. The player with the fewest points will be last.
|-
| style="padding-left: 2em;" | ''Least Points'' || The player with the fewest points will be first. The player with the most points will be last.
|-
| style="padding-left: 2em;" | ''Finish Order'' || Players are given placements in the order that they finished. This is the order in which their [[Set Placement Action]]s were fired. The player who finished first is given first place.
|-
| style="padding-left: 2em;" | ''Last Man Standing'' || Players are given placements in the order in which they were killed. Players who died first are placed last. With the players who haven't died, or those who died last being placed first.
|-
|}

===Player Settings===
These settings configure how the player moves and interacts with the minigame scene.

{| class="wikitable"
|-
! Property !! Description
|-
| '''Player Type''' || How the player is controlled. Can choose between ''Third Person'' and ''Top Down''.
|}

====Movement====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Movement Speed''' || The maximum speed the player can be made to move using a movement input.
|-
| '''Acceleration''' || How quickly the player accelerates to their ''Movement Speed'' while on the ground.
|-
| '''Deceleration''' || How quickly the player decelerates when not receiving a movement input.
|-
| ''Mid-air Acceleration'' || How quickly the player accelerates to their ''Movement Speed'' while airborne.
|-
| '''Gravity Scale''' || A multiplier that affects the strength of gravity felt by the player.
|-
| ''Max Step Height'' || The maximum height in units that players can walk up without needing to jump.
|-
| '''Can Jump''' || If the player is able to jump or not.
|-
| style="padding-left: 2em;" | '''Jump Speed''' || The power of the player's jump. Larger numbers will result in higher jumps.
|-
| '''Mid-air Jumps''' || How many times the player can jump while in mid-air before they need to touch the ground again.
|-
| '''Twinstick Controls''' || ''(Top Down player type only)'' Should the player use twinstick controls. When enabled, the player's facing direction is controlled separately from the movement direction. When disabled, the player will always face the direction of movement.
|-
|}

====Camera====
Only available if using the Top Down player.
{| class="wikitable"
|-
! Property !! Description
|-
| '''Camera Mode''' || The type of camera to use.
* Static: Remains in one place and never moves.
* Follow: Follow a single player around.
* Follow All: Moves to follow the average position between all players.
|-
| '''Camera Distance''' || How far back the camera is from its target (World origin for ''Static'' camera, Player for ''Follow'' camera, All Player average position for ''Follow All'' camera). The target can be offset using the ''Position Offset'' attribute.
|-
| '''View Angle''' || The camera's angle of elevation from the horizontal plane, in degrees. 0 is looking parallel to the ground. 90 is perpendicularly looking directly down from above.
|-
| '''Position Offset''' || How far back the camera is from its target. The target can be set using the ''Position Offset'' attribute.
|-
| '''Follow Area Shape''' || Should punching another player stun them.
|-
| style="padding-left: 2em;" | ''Square'' || Confines the camera to moving within a rectangular area.
|-
| style="padding-left: 4em;" | '''Left/Right Size''' || Width of the camera area on the X axis.
|-
| style="padding-left: 4em;" | '''Forward/Backward Size''' || Width of the camera area on the Z axis.
|-
| style="padding-left: 4em;" | '''Max X Move Distance''' || The maximum distance the camera can move from the left to the right. I.e. it can move half this distance from the center of the follow area.
|-
| style="padding-left: 4em;" | '''Max Z Move Distance''' || The maximum distance the camera can move forward and backward. I.e. it can move half this distance in both the forward and backward directions from the center of the follow area.
|-
| style="padding-left: 4em;" | '''Centre''' || The center of the follow area on the X/Z plane of the camera follow area.
|-
| style="padding-left: 2em;" | ''Circle'' || Confines the camera to moving within a rectangular area.
|-
| style="padding-left: 4em;" | '''Circle Diameter''' || The diameter of the follow are circle.
|-
| style="padding-left: 4em;" | '''Max Move Distance''' || The maximum distance the camera can move along any axis. I.e. it can move half this distance from the center to its maximum in a given direction.
|-
| style="padding-left: 4em;" | '''Circle Centre''' || The center of the follow area on the X/Z plane of the camera follow area.
|-
|}

====Punching====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Can Punch''' || If the player is able to punch using their fists when not holding an item.
''Note: With this disabled, the player is still able to use melee weapons''.
|-
| style="padding-left: 2em;" | '''Cooldown (s)''' || How long since the start of the last punch (in seconds) must the player wait before they can begin another punch.
|-
| style="padding-left: 2em;" | '''Damage''' || How much damage does each punch deal to other players.
|-
| style="padding-left: 2em;" | '''Punch Stuns Target''' || Should punching another player stun them.
|-
| style="padding-left: 4em;" | '''Punch Stun Duration (s)''' || The duration of the stun inflicted on other players who get punched, in seconds.
|-
|}

====Stuns ====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Immunity Duration''' || The duration in seconds since the last stun in which the player cannot be stunned again. Begins when the last stun finishes.
|-
|}

====Respawning====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Can Respawn''' || If the player should respawn when killed, or remain dead until the end of the round.
|-
| '''Respawn Time (s)''' || The time is seconds between dying and being respawned.
|-
| '''Invulnerable Time (s)''' || The time in seconds after respawning in which the player cannot take any damage.
|-
|}

====Event Triggers====
{| class="wikitable"
|-
! Property !! Description
|-
| '''On Weapon Hit''' || Event fired on the player when they are hit by a weapon.
|-
| style="padding-left: 2em;" | '''Weapon Type''' || The type(s) of weapon that will cause this event to fire.
|-
| '''On Tick''' || Event fired on the player continuously with a given interval.
|-
| style="padding-left: 2em;" | '''Interval''' || How long in seconds between each firing of this event. Can set either a constant value or a random value with lower and upper bounds.
|-
| '''On Death''' || Event that fires each time the player is killed.
|-
| '''On Respawn''' || Event that fires each time the player is respawned. This does not include the first time they are spawned at the beginning of a game or round.
|-
| '''On Round Start''' || Event that fires per player once per round on the initial spawn of the player. <br/>E.g. This will fire at the start of each round if multiple rounds are used, or just once at the start of the game if it only has a single round. Use a [[Logic Component]] ''Round Start'' trigger if you want to run actions that aren't tied to a player.
|-
| '''On Round End''' || Event that fires per player once per round when the round has ended. <br/>E.g. This will fire at the end of every round if multiple rounds are used, or just once at the end of the game if it only has a single round. Use a [[Logic Component]] ''Round End'' trigger if you want to run actions that aren't tied to a player.
|-
|}

==== Health ====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Use Health''' || If the player should use health or not. If not using health, any damage received will instantly kill the player.
|-
| style="padding-left: 2em;" | '''Show Health Bar''' || Whether or not a health bar should be displayed above every player's head.
|-
| style="padding-left: 2em;" | '''Health Points''' || How many health points should the player have.
|-
|}

==== Name Tags====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Name Tag Type''' || What type of player name tags should be used by this minigame? This setting changes how the nametag scales as it moves away from the camera and whether it is displayed in front of or behind objects in the world.
|-
| style="padding-left: 2em;" | ''Screen Space'' || Name tags keep a constant, fixed size on the screen regardless of how far away the player is from the camera. The nametag will appear above everything else in the scene.
|-
| style="padding-left: 2em;" | ''World Space'' || Name tags will shrink as they move farther away from the camera as any object typically would. The nametag will still appear above everything else in the scene however.
|-
| style="padding-left: 2em;" | ''True World Space'' || Name tags will shrink as they move farther away from the camera as any object typically would. The nametag will be occluded by scene objects. '''(Default value)'''
|-
|}

==Board Mod Settings==
=== Custom Spaces===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Custom Space Prefabs''' || A list of prefabs that can be used as custom board spaces. See [[Custom Board Space]] for more information.
|-
|}

=== Board Size ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Use Custom Board Size''' || Enabled the inputs to set a custom board size. If this is disabled, the board size is calculated automatically based on the placement of board spaces in the scene. Only enabled this if you have a need to set the board size manually.
|-
| '''Left/Right Size''' || The width of the board map playable area on the X axis, in units.
|-
| '''Forward/Backward Size''' || The width of the board map playable area on the Z axis, in units.
|-
| '''Map Center''' || The X/Z position of the center of the board map.
|}

=== Camera Settings ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Elevation Angle''' || The angle between the camera's view direction and the X/Z plane, in degrees.
|-
| '''Camera Mode''' || The type of camera view mode to use.
|-
| style="padding-left: 2em;" | ''Perspective'' || View the world with a 3D camera that can show depth and perspective.
|-
| style="padding-left: 4em;" | '''Field of View''' || The vertical field of view of the camera. Higher values result in more objects being seen around the edge of the view.
|-
| style="padding-left: 4em;" | '''Distance''' || The distance to the target from the camera.
|-
| style="padding-left: 2em;" | ''Orthographic'' || View the world with a 2D camera that displays everything at the same depth.
|-
| style="padding-left: 4em;" | '''View Size''' || The size of the camera's view. Technically, this is half the height of the camera view in units.
|-
|}

Mod Settings

2023-12-17T20:25:24Z

RBAdmin: /* Event Triggers */ Added On Round End trigger

When creating a mod there are many general settings that relate to the mod itself, rather than any specific [[Component]] or [[Gameobject]]. These settings are grouped into the special ''Minigame/Board Settings'' gameobject at the top of the [[Hierarchy Window]]. These control important attributes such as the mod's name/description, music/sound, rules, controls, lighting and screen effects.

==General Mod Settings==
===Minigame/Board Details===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Name'''||The name of the mod. This is the name used in-game only.
''Note: To set the name for the Steam Workshop, use the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
| '''Description'''
| The description of the mod as it appears in the:
*Minigame loading screen (minigame mods)
*Multiplayer lobby (board mods)
''Note: This is not the description for the Steam Workshop, that is set in the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
| '''Preview Image''' || The preview image that appears in the:
*Minigame loading screen (minigame mods)
*Multiplayer lobby (board mods)
''Note: This is not the preview image for the Steam Workshop, that is set in the [[Publishing to the Steam Workshop|Publish Mod Window]]''
|-
|}

===Music & Ambient Sound===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Music''' || The music that plays in the background while playing the minigame or on the board scene. This track will loop.
|-
| style="padding-left: 2em;" | '''Music Volume''' || The volume of the music.
|-
| '''Ambience''' || An ambient track to play in the background. This track will loop.
|-
| style="padding-left: 2em;" | '''Ambience Volume''' || The volume of the ambient track.
|-
|}

===Lighting===
These settings allow the lighting of the entire mod to be adjusted. This can set the tone of the mod, or create interesting effects such as making the mod very dark or setting very unusual lighting.

See [[Lighting Settings]] for the available options.

===Screen Effects===
Screen effects are post-processing style effects that are added to the final view of the scene before it is shown to the player. Screen effects include things like bloom and color correction.

See [[Screen Effects]] for the available options.

==Minigame Mod Settings==

===Minigame Settings ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Rounds''' || The number of rounds to use for the minigame.
|-
| '''End Conditions''' || How the minigame should end.
|-
| style="padding-left: 2em;" | ''Timer'' || The minigame will end after the timer expires.
|-
| style="padding-left: 4em;" | '''Round Duration (s)''' || The duration of a single round in seconds.
|-
| style="padding-left: 2em;" | ''ObtainPoints'' || The minigame will end after a single player has achieved a given number of points.
|-
| style="padding-left: 4em;" | '''Points to win''' || The number of points a single player needs to earn to win the minigame.
|-
| style="padding-left: 2em;" | ''RemainingPlayersAlive'' || The minigame will end when there are only a given number of players left alive.
|-
| style="padding-left: 4em;" | '''Players Alive''' || The number of players left alive for the minigame to end. ''Note: If this is greater than or equal to the number of players in the lobby, it will be set to 1 fewer than the lobby player count. E.g. if Players Alive is 4 but there are only 2 people in the lobby, it will be set to 1 instead of 4.''
|-
| style="padding-left: 2em;" | ''FinishMinigame'' || The minigame will end when all players have had a [[Set Placement Action]] fired for them.
|-
| '''Placement Condition''' || How the players are ordered to determine who came first to who came last.
|-
| style="padding-left: 2em;" | ''Most Points'' || The player with the most points will be first. The player with the fewest points will be last.
|-
| style="padding-left: 2em;" | ''Least Points'' || The player with the fewest points will be first. The player with the most points will be last.
|-
| style="padding-left: 2em;" | ''Finish Order'' || Players are given placements in the order that they finished. This is the order in which their [[Set Placement Action]]s were fired. The player who finished first is given first place.
|-
| style="padding-left: 2em;" | ''Last Man Standing'' || Players are given placements in the order in which they were killed. Players who died first are placed last. With the players who haven't died, or those who died last being placed first.
|-
|}

===Player Settings===
These settings configure how the player moves and interacts with the minigame scene.

{| class="wikitable"
|-
! Property !! Description
|-
| '''Player Type''' || How the player is controlled. Can choose between ''Third Person'' and ''Top Down''.
|}

====Movement====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Movement Speed''' || The maximum speed the player can be made to move using a movement input.
|-
| '''Acceleration''' || How quickly the player accelerates to their ''Movement Speed'' while on the ground.
|-
| '''Deceleration''' || How quickly the player decelerates when not receiving a movement input.
|-
| ''Mid-air Acceleration'' || How quickly the player accelerates to their ''Movement Speed'' while airborne.
|-
| '''Gravity Scale''' || A multiplier that affects the strength of gravity felt by the player.
|-
| ''Max Step Height'' || The maximum height in units that players can walk up without needing to jump.
|-
| '''Can Jump''' || If the player is able to jump or not.
|-
| style="padding-left: 2em;" | '''Jump Speed''' || The power of the player's jump. Larger numbers will result in higher jumps.
|-
| '''Mid-air Jumps''' || How many times the player can jump while in mid-air before they need to touch the ground again.
|-
| '''Twinstick Controls''' || ''(Top Down player type only)'' Should the player use twinstick controls. When enabled, the player's facing direction is controlled separately from the movement direction. When disabled, the player will always face the direction of movement.
|-
|}

====Camera====
Only available if using the Top Down player.
{| class="wikitable"
|-
! Property !! Description
|-
| '''Camera Mode''' || The type of camera to use.
* Static: Remains in one place and never moves.
* Follow: Follow a single player around.
* Follow All: Moves to follow the average position between all players.
|-
| '''Camera Distance''' || How far back the camera is from its target (World origin for ''Static'' camera, Player for ''Follow'' camera, All Player average position for ''Follow All'' camera). The target can be offset using the ''Position Offset'' attribute.
|-
| '''View Angle''' || The camera's angle of elevation from the horizontal plane, in degrees. 0 is looking parallel to the ground. 90 is perpendicularly looking directly down from above.
|-
| '''Position Offset''' || How far back the camera is from its target. The target can be set using the ''Position Offset'' attribute.
|-
| '''Follow Area Shape''' || Should punching another player stun them.
|-
| style="padding-left: 2em;" | ''Square'' || Confines the camera to moving within a rectangular area.
|-
| style="padding-left: 4em;" | '''Left/Right Size''' || Width of the camera area on the X axis.
|-
| style="padding-left: 4em;" | '''Forward/Backward Size''' || Width of the camera area on the Z axis.
|-
| style="padding-left: 4em;" | '''Max X Move Distance''' || The maximum distance the camera can move from the left to the right. I.e. it can move half this distance from the center of the follow area.
|-
| style="padding-left: 4em;" | '''Max Z Move Distance''' || The maximum distance the camera can move forward and backward. I.e. it can move half this distance in both the forward and backward directions from the center of the follow area.
|-
| style="padding-left: 4em;" | '''Centre''' || The center of the follow area on the X/Z plane of the camera follow area.
|-
| style="padding-left: 2em;" | ''Circle'' || Confines the camera to moving within a rectangular area.
|-
| style="padding-left: 4em;" | '''Circle Diameter''' || The diameter of the follow are circle.
|-
| style="padding-left: 4em;" | '''Max Move Distance''' || The maximum distance the camera can move along any axis. I.e. it can move half this distance from the center to its maximum in a given direction.
|-
| style="padding-left: 4em;" | '''Circle Centre''' || The center of the follow area on the X/Z plane of the camera follow area.
|-
|}

====Punching====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Can Punch''' || If the player is able to punch using their fists when not holding an item.
''Note: With this disabled, the player is still able to use melee weapons''.
|-
| style="padding-left: 2em;" | '''Cooldown (s)''' || How long since the start of the last punch (in seconds) must the player wait before they can begin another punch.
|-
| style="padding-left: 2em;" | '''Damage''' || How much damage does each punch deal to other players.
|-
| style="padding-left: 2em;" | '''Punch Stuns Target''' || Should punching another player stun them.
|-
| style="padding-left: 4em;" | '''Punch Stun Duration (s)''' || The duration of the stun inflicted on other players who get punched, in seconds.
|-
|}

====Stuns ====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Immunity Duration''' || The duration in seconds since the last stun in which the player cannot be stunned again. Begins when the last stun finishes.
|-
|}

====Respawning====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Can Respawn''' || If the player should respawn when killed, or remain dead until the end of the round.
|-
| '''Respawn Time (s)''' || The time is seconds between dying and being respawned.
|-
| '''Invulnerable Time (s)''' || The time in seconds after respawning in which the player cannot take any damage.
|-
|}

====Event Triggers====
{| class="wikitable"
|-
! Property !! Description
|-
| '''On Weapon Hit''' || Event fired on the player when they are hit by a weapon.
|-
| style="padding-left: 2em;" | '''Weapon Type''' || The type(s) of weapon that will cause this event to fire.
|-
| '''On Tick''' || Event fired on the player continuously with a given interval.
|-
| style="padding-left: 2em;" | '''Interval''' || How long in seconds between each firing of this event. Can set either a constant value or a random value with lower and upper bounds.
|-
| '''On Death''' || Event that fires each time the player is killed.
|-
| '''On Respawn''' || Event that fires each time the player is respawned. This does not include the first time they are spawned at the beginning of a game or round.
|-
| '''On Round Start''' || Event that fires per player once per round on the initial spawn of the player. <br/>E.g. This will fire at the start of each round if multiple rounds are used, or just once at the start of the game if it only has a single round. Use a [[Logic Component]] ''Round Start'' trigger if you want to run actions that aren't tied to a player.
|-
| '''On Round End''' || Event that fires per player once per round when the round has ended. <br/>E.g. This will fire at the end of every round if multiple rounds are used, or just once at the end of the game if it only has a single round. Use a [[Logic Component]] ''Round End'' trigger if you want to run actions that aren't tied to a player.
|-
|}

==== Health ====
{| class="wikitable"
|-
! Property !! Description
|-
| '''Use Health''' || If the player should use health or not. If not using health, any damage received will instantly kill the player.
|-
| style="padding-left: 2em;" | '''Show Health Bar''' || Whether or not a health bar should be displayed above every player's head.
|-
| style="padding-left: 2em;" | '''Health Points''' || How many health points should the player have.
|-
|}
==Board Mod Settings==
=== Custom Spaces===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Custom Space Prefabs''' || A list of prefabs that can be used as custom board spaces. See [[Custom Board Space]] for more information.
|-
|}

=== Board Size ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Use Custom Board Size''' || Enabled the inputs to set a custom board size. If this is disabled, the board size is calculated automatically based on the placement of board spaces in the scene. Only enabled this if you have a need to set the board size manually.
|-
| '''Left/Right Size''' || The width of the board map playable area on the X axis, in units.
|-
| '''Forward/Backward Size''' || The width of the board map playable area on the Z axis, in units.
|-
| '''Map Center''' || The X/Z position of the center of the board map.
|}

=== Camera Settings ===
{| class="wikitable"
|-
! Property !! Description
|-
| '''Elevation Angle''' || The angle between the camera's view direction and the X/Z plane, in degrees.
|-
| '''Camera Mode''' || The type of camera view mode to use.
|-
| style="padding-left: 2em;" | ''Perspective'' || View the world with a 3D camera that can show depth and perspective.
|-
| style="padding-left: 4em;" | '''Field of View''' || The vertical field of view of the camera. Higher values result in more objects being seen around the edge of the view.
|-
| style="padding-left: 4em;" | '''Distance''' || The distance to the target from the camera.
|-
| style="padding-left: 2em;" | ''Orthographic'' || View the world with a 2D camera that displays everything at the same depth.
|-
| style="padding-left: 4em;" | '''View Size''' || The size of the camera's view. Technically, this is half the height of the camera view in units.
|-
|}

Logic Component

2023-12-17T20:24:22Z

RBAdmin: /* Component Settings */ Added round start/end triggers

The logic component is a [[:Category:Gameplay Components|gameplay component]] that runs a series of [[Action|actions]] for different [[Event|events]].

== Component Settings ==
[[File:LogicComponent.png|thumb|500px|The Logic Component in the [[Inspector Window]]. You can add multiple events to a single logic component.]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Event''' || The event that triggers a list of Actions.
|-
| style="padding-left: 2em;" | ''Start'' || Triggered at the start of a minigame, as the countdown begins.
|-
| style="padding-left: 2em;" | ''Enable'' || Triggered each time this gameobject is enabled. This includes:
* being enabled automatically when the object is created as part of the scene as soon as the minigame loads (while still on the minigame load/intro screen)
* each time this gameobject is enabled by a [[Set Active Action]] if it was previously disabled.
|-
| style="padding-left: 2em;" | ''Update'' || Triggered every frame. Not consistent between players due to varying framerates. '''For consistent timed actions use the ''Timer'' event instead.'''
|-
| style="padding-left: 2em;" | ''Hit'' || Triggered when the object this component is attached to is hit by the player or [[Weapon Component|weapons]].
|-
| style="padding-left: 2em;" | ''Weapon Hit'' || Triggered when the object this component is attached to is hit by a [[Weapon Component|weapon]].
|-
| style="padding-left: 4em;" | '''Weapon Type''' || The type(s) of weapon hit that will cause the actions to be triggered.
|-
| style="padding-left: 2em;" | ''Timer'' || Triggered every x seconds.
|-
| style="padding-left: 4em;" | '''Interval''' || The number of seconds between the event firing. Use the Arrow beside the ''Interval'' value to set the mode.
|-
| style="padding-left: 6em;" | ''Constant'' || Actions are triggered repeatedly after a set number of seconds.
|-
| style="padding-left: 6em;" | ''Random Between Two Values'' || Actions are triggered repeatedly after a random amount of time. The minimum and maximum amount of time between each firing of the event can be set.
|-
| style="padding-left: 2em;" | ''Round Start'' || Triggered at the start of each minigame round, after the round start countdown.
|-
| style="padding-left: 2em;" | ''Round End'' || Triggered at the end of each minigame round.
|-
| '''Actions''' || The list of actions to run for the given Event.
|-
|}

== Example Usage ==
''Start'' can be useful to make something happen when the minigame begins.

''Timer'' with a random ''Interval'' can be used to add random effects to make the minigame more exciting. Use the arrow beside the value to change between constant and random values.

[[Category:Gameplay Components]]
[[Category:Components]]

Remove Trophy Action

2023-12-17T20:15:23Z

RBAdmin: Removed future content warning

[[File:RemoveTrophyAction.png|thumb|600px|The Remove Trophy action in the [[Action Editor]].]]
An action to remove one or more trophies from a player. This action can target players on multiple board spaces by using the ''Advanced'' '''Targets''' option.

The action will remove the number of trophies specified by the ''Trophies to Remove'' option. If the player doesn't have that many trophies, they will lose all that they have. If a player has no trophies, this action does nothing.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

To give players trophies, use the [[Give Trophy Action]].

[[Category:Actions]]

Main Page

2023-12-17T20:15:01Z

RBAdmin: /* Actions */ Added remove trophy action

__NOTOC__
'''Welcome to the Pummel Party Mod Editor Documentation'''

Using the Mod Editor you can create your own Minigames and Board Maps for Pummel Party.

<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
<div>
<div class="main-page-section">
== Getting started ==
If you're new to the mod editor, start here!
=== Information ===
*[[Introduction to the Mod Editor]]
*[[Publishing to the Steam Workshop|Publishing your mod to the Steam Workshop]]

=== Tutorials ===
*[[Tutorials/Creating Your First Mod|Creating your first mod]]
*[[Tutorials/Building A Board Mod|Building a board mod]]
*[[Tutorials/Building A Minigame Mod|Building a minigame mod]]
</div>

<div class="main-page-section">

==Mod Editor Windows==
Learn about the different windows that make up the Mod Editor.
{| class="wikitable"
|-
| '''Primary Windows'''
| [[Hierarchy Window]] - [[Inspector Window]] - [[Scene View]] - [[Asset Browser]] - [[Log Window]]
|-
| '''Other Windows'''
| [[Action Editor]] - [[Mod Validator|Mod Validator Window]] - [[Publishing to the Steam Workshop|Publish Window]] - [[Published Mods Window]]
|-
|}
</div>

<div class="main-page-section">

==Other Concepts==
These are some other miscellaneous concepts that are useful to know when creating mods.

'''General'''
* [[Mod Settings|Adjusting Mod Settings]]
* [[Unlocked Mod|Marking a published mod as Unlocked]]
* [[Mod Editor Shortcuts]]

'''Advanced'''
* [[Custom Board Space|Creating Custom Board Spaces]]
* [[Lighting Settings]]
* [[Screen Effects]]
</div>
</div>

<div>
<div class="main-page-section">

== Components ==
[[Component]]s are blocks of logic that are added to [[Gameobject]]s to give them unique functionality.
{| class="wikitable"
|-
| '''[[:Category:Gameplay Components|Gameplay]]'''
|-
| style="padding-left: 2em;" | '''General'''
| [[Logic Component|Logic]] - [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]
|-
| style="padding-left: 2em;" | '''Minigame only'''
| [[Item Component|Item]] - [[AI Navigation Node Component|AI Navigation Node]] - [[Player Spawn Component|Player Spawn]] - [[Spawner Component|Spawner]] - [[Trigger Component|Trigger]] - [[Weapon Component|Weapon]]
|-
| style="padding-left: 2em;" | '''Board only'''
| [[Board Space Component|Board Space]] - [[Board Space Event Component|Board Space Event]]
|-
| '''[[:Category:Rendering Components|Rendering]]'''
| [[Light Component|Light]] - [[Line Renderer Component|Line Renderer]] - [[Mesh Renderer Component|Mesh Renderer]] - [[Particle System Component|Particle System]] - [[Prop Component|Prop]] - [[Text Component|Text]] - [[Water Component|Water]]
|-
| '''[[:Category:Audio Components|Audio]]'''
| [[Audio Source Component| Audio Source]]
|-
| '''[[:Category:Physics Components|Physics]]'''
| [[Box Collider Component|Box Collider]] - [[Capsule Collider Component|Capsule Collider]] - [[Mesh Collider Component|Mesh Collider]] - [[Sphere Collider Component|Sphere Collider]]
|-
| '''Other'''
| [[Transform Component|Transform]] - [[Prefab Instance Component|Prefab Instance]] - [[Note Component|Note]]
|}
</div>

<div class="main-page-section">

== Assets ==
[[:Category:Assets|Assets]] are objects used in the creation of mods.
{| class="wikitable"
|-
| '''Assets'''
| [[Mesh Asset]] - [[Texture Asset]] - [[Audio Clip Asset]] - [[Material Asset]] - [[Prefab Asset]]
|-
| '''Importing Assets'''
| [[Importing Audio]] - [[Importing Images]] - [[Importing Models]]
|}
</div>

<div class="main-page-section">

== Actions ==
[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an [[Event]] is fired.
{| class="wikitable"
|-
| '''Minigame Logic'''
| [[Change Health Action]] - [[Change Player Velocity Action]] - [[Change Score Action]] - [[Drop Minigame Item Action]] - [[Give Minigame Item Action]] - [[Modify Player Action]] - [[Set Gravity Action]] - [[Set Placement Action]] - [[Stun Player Action]]
|-
| '''Board Logic'''
| [[Display Popup Action]] - [[Damage Player Action]] - [[Drop Keys Action]] - [[Give Item Action]] - [[Give Keys Action]] - [[Give Trophy Action]] - [[Heal Player Action]] - [[Move To Space Action]] - [[Remove Trophy Action]] - [[Set Board Space Active Action]] - [[Set Connection Active Action]] - [[Spawn Keys Action]]
|-
| '''Utility'''
|[[Kill Action]] - [[Play Sound Action]] - [[Set Active Action]] - [[Spawn Prefab Action]] - [[Wait Action]]
|-
| '''Movement'''
| [[Match Transform Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]]
|-
| '''Visuals'''
| [[Set Color Action]] - [[Set Player Visual Action]] - [[Spawn Effect Action]] - [[Show Message Action]]
|-
|}
</div>
</div>

</div>

Board Space Event Component

2023-11-21T23:41:39Z

RBAdmin: Remove outdated info

[[File:BoardSpaceEventComponentExample.png|thumb|800px|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.]]
The board space event component is a [[:Category:Gameplay Components|gameplay component]] that allows a set of [[Action]]s to be performed whenever a player lands on a custom board space. It can only be added from within [[Prefab Asset|prefabs]], as it is purpose is to add logic to [[Custom Board Space]]s (which exist as prefabs). Subsequently, it is only available in [[Board Mod]]s.

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 should be placed on the <dfn title="The gameobject at the top of the hierarchy">'''root gameobject'''</dfn> of a prefab that is used as a custom board space. When attached to any other gameobject, it will do nothing.

Add actions to the component by editing the On Enter [[Event]] in the inspector window.

== Component Settings ==
{| class="wikitable"
|-
! Property !! Description
|-
|'''On Player Land''' || A set of [[Action]]s to perform whenever a player lands on this space. This means when they end their turn on the space.
|-
|'''On Player Passing''' || A set of [[Action]]s to perform whenever a player walks over this space. This could be before ending their turn or when they have several steps to go. <br/> Note: This event is not triggered when riding a rocket over the 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 [[:Category:Actions|actions]] to get an idea of what actions can be performed. Note that not all actions are usable on Board Mods.

[[Category:Gameplay Components]]
[[Category:Components]]

Remove Trophy Action

2023-11-16T22:44:32Z

RBAdmin:

'''NOTICE: This content is planned for a future update. Everything here is subject to change and may or may not be added to the game.'''

[[File:RemoveTrophyAction.png|thumb|600px|The Remove Trophy action in the [[Action Editor]].]]
An action to remove one or more trophies from a player. This action can target players on multiple board spaces by using the ''Advanced'' '''Targets''' option.

The action will remove the number of trophies specified by the ''Trophies to Remove'' option. If the player doesn't have that many trophies, they will lose all that they have. If a player has no trophies, this action does nothing.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

To give players trophies, use the [[Give Trophy Action]].

[[Category:Actions]]

Give Trophy Action

2023-11-16T22:41:31Z

RBAdmin: Update content for future patch

[[File:GiveTrophyAction.png|thumb|600px|The Give Trophy action in the [[Action Editor]].]]
An action to give a player a trophy. This action can target players on multiple board spaces by using the ''Advanced'' '''Targets''' option.

The action can give one or more trophies to the targeted player(s). The maximum number of trophies that can be given at once is 20. '''(This is an upcoming feature, for the live version of the mod editor, use multiple actions to give multiple trophies)'''

The ''Play Fanfare Sound'' option will play a cheering/victory sound for the player when they receive the trophy. Without this enabled, the trophy will still be shown but the sound will not play.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

To remove trophies, use the [[Remove Trophy Action]].

[[Category:Actions]]

File:RemoveTrophyAction.png

2023-11-16T22:39:33Z

RBAdmin:

File:GiveTrophyAction.png

2023-11-16T22:39:24Z

RBAdmin: RBAdmin uploaded a new version of File:GiveTrophyAction.png

Remove Trophy Action

2023-11-16T22:34:12Z

RBAdmin: Initial content

Board Space Component

2023-08-22T05:04:11Z

RBAdmin: /* Item Space */

The board space component is a [[:Category:Gameplay Components|gameplay component]] that creates a board space and its connections to other board spaces in a [[Board Mod]].

Board space components cannot be added to gameobjects that have child gameobjects in the hierarchy. They also cannot be used within prefabs.
Gameobjects with a board space component cannot have any child gameobjects added. They are given a unique icon and color in the hierarchy.

== Connecting Board Spaces ==
Board spaces 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 space to another existing board space, click the destination board spaces 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 space.

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

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

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

==Board Space Types==
[[File:BoardSpaceTypes.png|thumb|right|600px|The 8 different board space types, not including custom spaces.]]
There are eight types of board spaces provided, plus the Custom type which lets you select your own [[Custom Board Space]].
===Pathing Space===
This board space is invisible. It can take connections in and have connections out to other board spaces. Players cannot land on this space and passing one doesn't cost a step. Use these spaces to create more advanced paths between visible spaces, rather than a straight-line connection.
===Start Space===
This space is where the game will start. All players spawn on the start space. There must be exactly one start space per board mod. Nothing happens when landing on a start space.
===Heal Space===
The heal space will heal any player that lands on it by 10 health points.
===Gold Space===
The gold space rewards the player that landed on it with 5 keys.
===Hazard Space===
Landing on a hazard space will deal 5 health points of damage to the player.
===Item Space===
The item space gives any player who lands on it a single item. This item can be any item excluding the Dark Summoning Staff, Arcade Machine, Giga Laser and Nuke Barrel (these are only available from the weapons cache).

===Recruit Space===
The first player to land on a recruit space can claim the space. They can decide between having the reaper:
* steal 9-12 health, damaging the player and healing the space owner.
* steal 6 keys, taking them from the player and giving them to the space owner.
When claiming a recruit space, all connected recruit spaces will also be claimed.
===Graveyard Space===
The graveyard space is a special space that is used when a player dies. You should include at least one graveyard space in a map for players to respawn at. Without this, players will respawn at the Start space. If there are multiple graveyards the player is respawned at the one furthest away from the trophy chest. Graveyard spaces cannot have incoming connections, only outgoing connections meant to put the player back onto the board.

===Custom Space===
You can create [[Custom Board Space|custom board spaces]] using prefabs. This is a slightly more advanced feature, but it can help make a board unique. These spaces use a set of [[Action]]s in a [[Board Space Event Component]] to define what happens when players land on them.

== Component Settings ==
[[File:BoardSpaceComponent.png|thumb|right|500px|The Board Space component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Type''' || The type of board space.
|-
| style="padding-left: 2em;" | '''Custom Space Prefab'''<br />''(Only for Type of "Custom")'' || The prefab that is used for this [[Custom Board Space]]. The list will be empty by default; add options through the board's [[Mod Settings]].
|-
| '''Supports Goal''' || If this board space is allowed to spawn the trophy chest or weapon cache.
|-
| '''Can be landed on'''<br />''(Only for Type of "Custom")'' || Set whether or not this custom board space can be landed on by players. In other words, does it cost a step to walk over this space. Disabling this will cause players to pass over the space without costing a step, meaning they can never end their turn on this space. They will still run the On Player Passing event of a [[Board Space Event Component]] as they pass over the space.
|-
|'''Custom Goal Position''' || Should the location of the goal chest and weapons cache be set manually for this board space. If false, the game will choose the best spot based on the location and direction of other board spaces and connections. Not available for ''Pathing'' and ''Graveyard'' spaces, or when ''Supports Goal'' is false as these spaces cannot spawn the chest/weapons cache.
|-
| style="padding-left: 2em;" | '''Spawn Rotation''' || The direction around the board space to spawn the chest/weapons cache at.
|-
| style="padding-left: 2em;" | '''Spawn Distance''' || The distance from the board space to spawn the chest/weapons cache.
|-
|'''Start Disabled''' || When enabled, the board space will be disabled at the start of a game. It can be re-enabled during the game by using a [[Set Board Space Active Action]].
|-
|'''Outgoing Connections''' || A list of all connections leaving this board space. Here you can adjust their transition type.
|-
| style="padding-left: 2em;" | '''Player Transition''' || How the player should move along the connection. There are three options: ''Walk'', ''Jump'' and ''Teleport''.
|-
| style="padding-left: 4em;" | ''Walk'' || The player will walk from one board space to the next. This is the default behaviour.
|-
| style="padding-left: 4em;" | ''Jump'' || The player will perform a quick jumping animation from one board space to the next. This is useful if the board spaces are separated by a gap or are at different elevations.
|-
| style="padding-left: 4em;" | ''Teleport'' || The player will instantly teleport from one board space to the next. This mode hides the path between the spaces.
|-
| style="padding-left: 2em;" | '''Start Disabled''' || When enabled, the connection will be disabled at the start of a game. It can be re-enabled by using a [[Set Connection Active Action]].
|-
|}

An ''Align board space to ground'' button is available to quickly position and rotate the board space so that its centre is placed flush with the ground beneath it.

== Connections ==
[[File:BoardConnectionTypes.png|600px|clear|thumb|The three different connection types and how they appear in the mod editor when enabled and disabled. They are Walk (Left), Jump (Center) and Teleport (Right)]]

Board spaces are connected by connection. Each connection has an origin space, a destination space, a transition type and a direction. The origin space is used to begin the creation of the connection and the destination is used to end the creation. The direction is from the origin to the destination. The transition type of a connection is set once the connection has been created by selecting the origin space and using the [[Inspector Window]].

The Walk transition is the default transition type and causes players to simply walk between each board space.

The Jump transition causes the player to perform a jumping animation from the origin space to the destination space. The Rocket skewer can fly along this type. The Bunny will also perform a jump along this type. This transition type is visually more suited to moving the player between board spaces that are at different elevations or that have a gap between them that doesn't make sense to walk across.

The Teleport transition causes the player to instantly blink from the origin space to the destination space. This type still costs a turn. The rocket skewer item will teleport when it reaches the origin space. The Bunny will also teleport. Teleport connections don't draw the black line between the origin and destination space, so they are suited to moving the player over long distances across the board, or to different areas only accessible via teleporting.

<br clear="all">

== 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.

[[Category:Gameplay Components]]
[[Category:Components]]

Board Space Component

2023-08-22T04:54:10Z

RBAdmin: /* Component Settings */ Added "Can be landed on" info

The board space component is a [[:Category:Gameplay Components|gameplay component]] that creates a board space and its connections to other board spaces in a [[Board Mod]].

Board space components cannot be added to gameobjects that have child gameobjects in the hierarchy. They also cannot be used within prefabs.
Gameobjects with a board space component cannot have any child gameobjects added. They are given a unique icon and color in the hierarchy.

== Connecting Board Spaces ==
Board spaces 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 space to another existing board space, click the destination board spaces 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 space.

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

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

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

==Board Space Types==
[[File:BoardSpaceTypes.png|thumb|right|600px|The 8 different board space types, not including custom spaces.]]
There are eight types of board spaces provided, plus the Custom type which lets you select your own [[Custom Board Space]].
===Pathing Space===
This board space is invisible. It can take connections in and have connections out to other board spaces. Players cannot land on this space and passing one doesn't cost a step. Use these spaces to create more advanced paths between visible spaces, rather than a straight-line connection.
===Start Space===
This space is where the game will start. All players spawn on the start space. There must be exactly one start space per board mod. Nothing happens when landing on a start space.
===Heal Space===
The heal space will heal any player that lands on it by 10 health points.
===Gold Space===
The gold space rewards the player that landed on it with 5 keys.
===Hazard Space===
Landing on a hazard space will deal 5 health points of damage to the player.
===Item Space===
The item space gives any player who lands on it a single item.
===Recruit Space===
The first player to land on a recruit space can claim the space. They can decide between having the reaper:
* steal 9-12 health, damaging the player and healing the space owner.
* steal 6 keys, taking them from the player and giving them to the space owner.
When claiming a recruit space, all connected recruit spaces will also be claimed.
===Graveyard Space===
The graveyard space is a special space that is used when a player dies. You should include at least one graveyard space in a map for players to respawn at. Without this, players will respawn at the Start space. If there are multiple graveyards the player is respawned at the one furthest away from the trophy chest. Graveyard spaces cannot have incoming connections, only outgoing connections meant to put the player back onto the board.

===Custom Space===
You can create [[Custom Board Space|custom board spaces]] using prefabs. This is a slightly more advanced feature, but it can help make a board unique. These spaces use a set of [[Action]]s in a [[Board Space Event Component]] to define what happens when players land on them.

== Component Settings ==
[[File:BoardSpaceComponent.png|thumb|right|500px|The Board Space component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Type''' || The type of board space.
|-
| style="padding-left: 2em;" | '''Custom Space Prefab'''<br />''(Only for Type of "Custom")'' || The prefab that is used for this [[Custom Board Space]]. The list will be empty by default; add options through the board's [[Mod Settings]].
|-
| '''Supports Goal''' || If this board space is allowed to spawn the trophy chest or weapon cache.
|-
| '''Can be landed on'''<br />''(Only for Type of "Custom")'' || Set whether or not this custom board space can be landed on by players. In other words, does it cost a step to walk over this space. Disabling this will cause players to pass over the space without costing a step, meaning they can never end their turn on this space. They will still run the On Player Passing event of a [[Board Space Event Component]] as they pass over the space.
|-
|'''Custom Goal Position''' || Should the location of the goal chest and weapons cache be set manually for this board space. If false, the game will choose the best spot based on the location and direction of other board spaces and connections. Not available for ''Pathing'' and ''Graveyard'' spaces, or when ''Supports Goal'' is false as these spaces cannot spawn the chest/weapons cache.
|-
| style="padding-left: 2em;" | '''Spawn Rotation''' || The direction around the board space to spawn the chest/weapons cache at.
|-
| style="padding-left: 2em;" | '''Spawn Distance''' || The distance from the board space to spawn the chest/weapons cache.
|-
|'''Start Disabled''' || When enabled, the board space will be disabled at the start of a game. It can be re-enabled during the game by using a [[Set Board Space Active Action]].
|-
|'''Outgoing Connections''' || A list of all connections leaving this board space. Here you can adjust their transition type.
|-
| style="padding-left: 2em;" | '''Player Transition''' || How the player should move along the connection. There are three options: ''Walk'', ''Jump'' and ''Teleport''.
|-
| style="padding-left: 4em;" | ''Walk'' || The player will walk from one board space to the next. This is the default behaviour.
|-
| style="padding-left: 4em;" | ''Jump'' || The player will perform a quick jumping animation from one board space to the next. This is useful if the board spaces are separated by a gap or are at different elevations.
|-
| style="padding-left: 4em;" | ''Teleport'' || The player will instantly teleport from one board space to the next. This mode hides the path between the spaces.
|-
| style="padding-left: 2em;" | '''Start Disabled''' || When enabled, the connection will be disabled at the start of a game. It can be re-enabled by using a [[Set Connection Active Action]].
|-
|}

An ''Align board space to ground'' button is available to quickly position and rotate the board space so that its centre is placed flush with the ground beneath it.

== Connections ==
[[File:BoardConnectionTypes.png|600px|clear|thumb|The three different connection types and how they appear in the mod editor when enabled and disabled. They are Walk (Left), Jump (Center) and Teleport (Right)]]

Board spaces are connected by connection. Each connection has an origin space, a destination space, a transition type and a direction. The origin space is used to begin the creation of the connection and the destination is used to end the creation. The direction is from the origin to the destination. The transition type of a connection is set once the connection has been created by selecting the origin space and using the [[Inspector Window]].

The Walk transition is the default transition type and causes players to simply walk between each board space.

The Jump transition causes the player to perform a jumping animation from the origin space to the destination space. The Rocket skewer can fly along this type. The Bunny will also perform a jump along this type. This transition type is visually more suited to moving the player between board spaces that are at different elevations or that have a gap between them that doesn't make sense to walk across.

The Teleport transition causes the player to instantly blink from the origin space to the destination space. This type still costs a turn. The rocket skewer item will teleport when it reaches the origin space. The Bunny will also teleport. Teleport connections don't draw the black line between the origin and destination space, so they are suited to moving the player over long distances across the board, or to different areas only accessible via teleporting.

<br clear="all">

== 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.

[[Category:Gameplay Components]]
[[Category:Components]]

Tutorials/Creating Your First Mod

2023-08-21T03:54:52Z

RBAdmin: /* Creating the Mod */

Welcome! This is a general tutorial recommended for those who have never used the mod editor before or anyone who needs a refresher on the process of creating a mod. This tutorial covers mod development from initial creation through to publishing on Steam.

== Accessing the Mod Editor ==
[[File:ModEditorMainMenuButton.png|400px|thumb|right|Buttons to access the Mod Editor from the main menu.]]
The mod editor can be accessed from the Pummel Party main menu by choosing ''Workshop > Mod Editor''
<br clear=all>
[[File:ModEditorWelcomeScreen.png|400px|thumb|right|Mod Editor Welcome Screen.]]
Once the mod editor loads, you'll be greeted with the welcome screen. This screen allows you to create new mods, open existing mods, access documentation and the workshop, and return to the main menu. ''Tip: If you don't see this window, or you've closed it, it can be opened from the toolbar using "Window > Welcome Screen"''
<br clear=all>
== Creating the Mod ==
[[File:ModEditorNewModPopup.png|600px|thumb|right|The new mod window.]]
From the welcome screen, select ''New Mod''. This displays the ''New Mod'' window. If you've closed the welcome screen you can instead use ''File > New Mod'' to go directly to the New Mod window.

From here you can choose a mod template to use. Templates provide a preconfigured set of objects, assets and settings. Take note of the mod type of a template as '''this cannot be changed later'''. Each type of mod is played in a different way and provides access to different [[:Category:Components|components]] and [[Mod Settings]]. When starting out it is recommended to use a template that closest matches the type of minigame or board you wish to build. Everything within the templates can be changed and removed; they are only there for convenience to help get you started with something playable.
<br clear=all>
This tutorial will create a simple minigame mod. We'll choose the Minimal Third Person template to get started. Once a template is selected, the mod must be named. This name can be changed later. Once you have entered a name, click OK to create and load the new mod.

If you don't want to use a template, you can choose either of the ''Empty'' options to create a new mod from scratch. See the tutorials for [[Tutorials/Building A Minigame Mod|building a minigame mod]] and [[Tutorials/Building A Board Mod|building a board mod]] to see the steps to create those mod types from scratch.

== Developing the Mod ==
[[File:ThirdPersonTemplateLoaded.png|center|500px]]
The mod has been created from the template and is ready to be edited. You will now be using the primary windows of the mod editor to create [[Gameobject]]s, with [[Component]]s adding functionality to those gameobjects. It is recommended you read the [[Introduction to the Mod Editor]] to familiarize yourself with the core concepts.

=== Navigating in the scene view ===
To add and edit gameobjects, it is helpful to have good control over the scene view. To rotate the camera, hold right-click and move the mouse to look around. To move the camera, again hold right-click and use the WASD keys to move forward, left, back and right. Q and E allow you to move down and up. The scroll wheel will move the camera forward and backward. You can also use the arrow keys to move at any time, without right-click being held. Finally, you can hold the middle-mouse button and drag the mouse to pan the view.

Holding SHIFT will move the camera faster.

You can focus the camera on an object by selecting it (either in the scene view or the hierarchy window) and pressing F on the keyboard.

=== Adding Gameobjects ===
[[File:HierarchyContextMenu.png|thumb|right|250px|These options allow gameobjects to be created, each with different components already attached for convenience.]]
Adding gameobjects is done from the [[Hierarchy Window]]. Right-click the hierarchy and choose one of the gameobject options to add a new gameobject. You can also use the ''Gameobject'' tab in the toolbar. We'll place some cubes to act as blocks for players to jump on or hide behind. Right-click the hierarchy and choose ''3D Object > Cube'' to place a cube. It will be put at the origin of the world with an x,y,z position of 0,0,0. Select it in the scene view by left-clicking on it. You can use the gizmos that appear to move, rotate and scale the selected gameobject. Use the buttons in the top left of the toolbar to change which gizmo is available. [[File:ObjectSelectionModeButtons.png|thumb|300px|The Pan, Transform, Rotate and Scale selection buttons. <br />''Tip: You can also use the Q, W, E and R keys to switch between these modes.'']]

With the cube selected, enter transform mode and drag the arrow gizmos in the scene view to position the cube in the scene.

<br clear=all>
=== Adding Components ===
[[File:AddComponentButton.png|thumb|right|200px|The Add Component button.]]
Components can be added to gameobject. Start by selecting a gameobject using either the scene view or the hierarchy window. With a gameobject selected use the inspector window and click ''Add Component''. This displays a grouped list of components that can be added. If a component cannot be added, it will appear disabled in this list; you can hover over the option to find out why it is disabled.
[[File:ExampleComponentList.png|thumb|right|300px|The component categories and some of the components you can add.]]
<br clear=all>
=== Adjusting the Mod Settings ===
[[File:ExampleModSettings.png|thumb|right|500px|The mod settings in the inspector window.]]
A variety of settings can be adjusted to change many aspects of the mod including what the rules are, how the mod plays, what background music is used and even how the lighting should look. You can access the mod settings using the special object at the top of the hierarchy. The mod settings will be displayed in the inspector while this object is selected.
<br clear=all>
=== Play-testing the mod ===
[[File: PlayPauseStopButtons.png|center]]
You can test the mod by clicking the play button [▶] at the center-top of the mod editor. While the mod is being tested, it cannot be edited. To stop testing the mod, click the stop button [⬛]. If your cursor is locked, hit escape to pause the test and free your cursor. While testing a mod, you can use the pause button [⏸] to pause the game.

== Publishing your mod ==
Once you have finished developing your mod you can publish it to the Steam Workshop. With your mod on the workshop, other players can subscribe to it and play it. You can publish a mod as long as it has no validation errors when using the [[Mod Validator]].

From the toolbar select ''File > Publish To Workshop'' to begin the publishing process. [[File:PublishModOption.png|thumb|200px|right|The File menu allows you to initiate the publishing of your mod.]] [[File:PublishModPopup.png|thumb|400px|right|The publish to workshop window.]] This displays the publish window. Information entered here will be displayed on the mod's steam workshop page. See [[Publishing to the Steam Workshop]] for a detailed explanation of the different options. Clicking "Publish" will upload your mod to the Steam Workshop and open the steam overlay to display the workshop page.
<br clear=all>
Congratulations, you have learned how to create, develop and publish a pummel party mod!

=== Sharing your mod with others ===
Other players need to subscribe to your mod to play it. You can send them a link to the workshop page of the mod, or they can find and subscribe to the mod through the [[Mod Browser]] in-game.

If you want to play your mod with friends, you can invite them to a lobby where the host has the mod subscribed and enabled. This will automatically download the mod for all other players that aren't already subscribed to the mod.

[[Category:Tutorials]]

Main Page

2023-08-21T03:40:29Z

RBAdmin: /* Components */ Move Logic to General from Minigame-Only

__NOTOC__
'''Welcome to the Pummel Party Mod Editor Documentation'''

Using the Mod Editor you can create your own Minigames and Board Maps for Pummel Party.

<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
<div>
<div class="main-page-section">
== Getting started ==
If you're new to the mod editor, start here!
=== Information ===
*[[Introduction to the Mod Editor]]
*[[Publishing to the Steam Workshop|Publishing your mod to the Steam Workshop]]

=== Tutorials ===
*[[Tutorials/Creating Your First Mod|Creating your first mod]]
*[[Tutorials/Building A Board Mod|Building a board mod]]
*[[Tutorials/Building A Minigame Mod|Building a minigame mod]]
</div>

<div class="main-page-section">

==Mod Editor Windows==
Learn about the different windows that make up the Mod Editor.
{| class="wikitable"
|-
| '''Primary Windows'''
| [[Hierarchy Window]] - [[Inspector Window]] - [[Scene View]] - [[Asset Browser]] - [[Log Window]]
|-
| '''Other Windows'''
| [[Action Editor]] - [[Mod Validator|Mod Validator Window]] - [[Publishing to the Steam Workshop|Publish Window]] - [[Published Mods Window]]
|-
|}
</div>

<div class="main-page-section">

==Other Concepts==
These are some other miscellaneous concepts that are useful to know when creating mods.

'''General'''
* [[Mod Settings|Adjusting Mod Settings]]
* [[Unlocked Mod|Marking a published mod as Unlocked]]
* [[Mod Editor Shortcuts]]

'''Advanced'''
* [[Custom Board Space|Creating Custom Board Spaces]]
* [[Lighting Settings]]
* [[Screen Effects]]
</div>
</div>

<div>
<div class="main-page-section">

== Components ==
[[Component]]s are blocks of logic that are added to [[Gameobject]]s to give them unique functionality.
{| class="wikitable"
|-
| '''[[:Category:Gameplay Components|Gameplay]]'''
|-
| style="padding-left: 2em;" | '''General'''
| [[Logic Component|Logic]] - [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]
|-
| style="padding-left: 2em;" | '''Minigame only'''
| [[Item Component|Item]] - [[AI Navigation Node Component|AI Navigation Node]] - [[Player Spawn Component|Player Spawn]] - [[Spawner Component|Spawner]] - [[Trigger Component|Trigger]] - [[Weapon Component|Weapon]]
|-
| style="padding-left: 2em;" | '''Board only'''
| [[Board Space Component|Board Space]] - [[Board Space Event Component|Board Space Event]]
|-
| '''[[:Category:Rendering Components|Rendering]]'''
| [[Light Component|Light]] - [[Line Renderer Component|Line Renderer]] - [[Mesh Renderer Component|Mesh Renderer]] - [[Particle System Component|Particle System]] - [[Prop Component|Prop]] - [[Text Component|Text]] - [[Water Component|Water]]
|-
| '''[[:Category:Audio Components|Audio]]'''
| [[Audio Source Component| Audio Source]]
|-
| '''[[:Category:Physics Components|Physics]]'''
| [[Box Collider Component|Box Collider]] - [[Capsule Collider Component|Capsule Collider]] - [[Mesh Collider Component|Mesh Collider]] - [[Sphere Collider Component|Sphere Collider]]
|-
| '''Other'''
| [[Transform Component|Transform]] - [[Prefab Instance Component|Prefab Instance]] - [[Note Component|Note]]
|}
</div>

<div class="main-page-section">

== Assets ==
[[:Category:Assets|Assets]] are objects used in the creation of mods.
{| class="wikitable"
|-
| '''Assets'''
| [[Mesh Asset]] - [[Texture Asset]] - [[Audio Clip Asset]] - [[Material Asset]] - [[Prefab Asset]]
|-
| '''Importing Assets'''
| [[Importing Audio]] - [[Importing Images]] - [[Importing Models]]
|}
</div>

<div class="main-page-section">

== Actions ==
[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an [[Event]] is fired.
{| class="wikitable"
|-
| '''Minigame Logic'''
| [[Change Health Action]] - [[Change Player Velocity Action]] - [[Change Score Action]] - [[Drop Minigame Item Action]] - [[Give Minigame Item Action]] - [[Modify Player Action]] - [[Set Gravity Action]] - [[Set Placement Action]] - [[Stun Player Action]]
|-
| '''Board Logic'''
| [[Display Popup Action]] - [[Damage Player Action]] - [[Drop Keys Action]] - [[Give Item Action]] - [[Give Keys Action]] - [[Give Trophy Action]] - [[Heal Player Action]] - [[Move To Space Action]] - [[Set Board Space Active Action]] - [[Set Connection Active Action]] - [[Spawn Keys Action]]
|-
| '''Utility'''
|[[Kill Action]] - [[Play Sound Action]] - [[Set Active Action]] - [[Spawn Prefab Action]] - [[Wait Action]]
|-
| '''Movement'''
| [[Match Transform Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]]
|-
| '''Visuals'''
| [[Set Color Action]] - [[Set Player Visual Action]] - [[Spawn Effect Action]] - [[Show Message Action]]
|-
|}
</div>
</div>

</div>

Board Space Component

2023-08-21T03:34:18Z

RBAdmin: /* Example Usage */ Added connection type info

The board space component is a [[:Category:Gameplay Components|gameplay component]] that creates a board space and its connections to other board spaces in a [[Board Mod]].

Board space components cannot be added to gameobjects that have child gameobjects in the hierarchy. They also cannot be used within prefabs.
Gameobjects with a board space component cannot have any child gameobjects added. They are given a unique icon and color in the hierarchy.

== Connecting Board Spaces ==
Board spaces 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 space to another existing board space, click the destination board spaces 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 space.

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

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

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

==Board Space Types==
[[File:BoardSpaceTypes.png|thumb|right|600px|The 8 different board space types, not including custom spaces.]]
There are eight types of board spaces provided, plus the Custom type which lets you select your own [[Custom Board Space]].
===Pathing Space===
This board space is invisible. It can take connections in and have connections out to other board spaces. Players cannot land on this space and passing one doesn't cost a step. Use these spaces to create more advanced paths between visible spaces, rather than a straight-line connection.
===Start Space===
This space is where the game will start. All players spawn on the start space. There must be exactly one start space per board mod. Nothing happens when landing on a start space.
===Heal Space===
The heal space will heal any player that lands on it by 10 health points.
===Gold Space===
The gold space rewards the player that landed on it with 5 keys.
===Hazard Space===
Landing on a hazard space will deal 5 health points of damage to the player.
===Item Space===
The item space gives any player who lands on it a single item.
===Recruit Space===
The first player to land on a recruit space can claim the space. They can decide between having the reaper:
* steal 9-12 health, damaging the player and healing the space owner.
* steal 6 keys, taking them from the player and giving them to the space owner.
When claiming a recruit space, all connected recruit spaces will also be claimed.
===Graveyard Space===
The graveyard space is a special space that is used when a player dies. You should include at least one graveyard space in a map for players to respawn at. Without this, players will respawn at the Start space. If there are multiple graveyards the player is respawned at the one furthest away from the trophy chest. Graveyard spaces cannot have incoming connections, only outgoing connections meant to put the player back onto the board.

===Custom Space===
You can create [[Custom Board Space|custom board spaces]] using prefabs. This is a slightly more advanced feature, but it can help make a board unique. These spaces use a set of [[Action]]s in a [[Board Space Event Component]] to define what happens when players land on them.

== Component Settings ==
[[File:BoardSpaceComponent.png|thumb|right|500px|The Board Space component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Type''' || The type of board space.
|-
| style="padding-left: 2em;" | '''Custom Space Prefab'''<br />''(Only for Type of "Custom")'' || The prefab that is used for this [[Custom Board Space]]. The list will be empty by default; add options through the board's [[Mod Settings]].
|-
| '''Supports Goal''' || If this board space is allowed to spawn the trophy chest or weapon cache.
|-
|'''Custom Goal Position''' || Should the location of the goal chest and weapons cache be set manually for this board space. If false, the game will choose the best spot based on the location and direction of other board spaces and connections. Not available for ''Pathing'' and ''Graveyard'' spaces, or when ''Supports Goal'' is false as these spaces cannot spawn the chest/weapons cache.
|-
| style="padding-left: 2em;" | '''Spawn Rotation''' || The direction around the board space to spawn the chest/weapons cache at.
|-
| style="padding-left: 2em;" | '''Spawn Distance''' || The distance from the board space to spawn the chest/weapons cache.
|-
|'''Start Disabled''' || When enabled, the board space will be disabled at the start of a game. It can be re-enabled during the game by using a [[Set Board Space Active Action]].
|-
|'''Outgoing Connections''' || A list of all connections leaving this board space. Here you can adjust their transition type.
|-
| style="padding-left: 2em;" | '''Player Transition''' || How the player should move along the connection. There are three options: ''Walk'', ''Jump'' and ''Teleport''.
|-
| style="padding-left: 4em;" | ''Walk'' || The player will walk from one board space to the next. This is the default behaviour.
|-
| style="padding-left: 4em;" | ''Jump'' || The player will perform a quick jumping animation from one board space to the next. This is useful if the board spaces are separated by a gap or are at different elevations.
|-
| style="padding-left: 4em;" | ''Teleport'' || The player will instantly teleport from one board space to the next. This mode hides the path between the spaces.
|-
| style="padding-left: 2em;" | '''Start Disabled''' || When enabled, the connection will be disabled at the start of a game. It can be re-enabled by using a [[Set Connection Active Action]].
|-
|}

An ''Align board space to ground'' button is available to quickly position and rotate the board space so that its centre is placed flush with the ground beneath it.

== Connections ==
[[File:BoardConnectionTypes.png|600px|clear|thumb|The three different connection types and how they appear in the mod editor when enabled and disabled. They are Walk (Left), Jump (Center) and Teleport (Right)]]

Board spaces are connected by connection. Each connection has an origin space, a destination space, a transition type and a direction. The origin space is used to begin the creation of the connection and the destination is used to end the creation. The direction is from the origin to the destination. The transition type of a connection is set once the connection has been created by selecting the origin space and using the [[Inspector Window]].

The Walk transition is the default transition type and causes players to simply walk between each board space.

The Jump transition causes the player to perform a jumping animation from the origin space to the destination space. The Rocket skewer can fly along this type. The Bunny will also perform a jump along this type. This transition type is visually more suited to moving the player between board spaces that are at different elevations or that have a gap between them that doesn't make sense to walk across.

The Teleport transition causes the player to instantly blink from the origin space to the destination space. This type still costs a turn. The rocket skewer item will teleport when it reaches the origin space. The Bunny will also teleport. Teleport connections don't draw the black line between the origin and destination space, so they are suited to moving the player over long distances across the board, or to different areas only accessible via teleporting.

<br clear="all">

== 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.

[[Category:Gameplay Components]]
[[Category:Components]]

File:BoardConnectionTypes.png

2023-08-21T03:25:38Z

RBAdmin:

Main Page

2023-08-21T03:16:51Z

RBAdmin: /* Mod Editor Windows */

__NOTOC__
'''Welcome to the Pummel Party Mod Editor Documentation'''

Using the Mod Editor you can create your own Minigames and Board Maps for Pummel Party.

<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
<div>
<div class="main-page-section">
== Getting started ==
If you're new to the mod editor, start here!
=== Information ===
*[[Introduction to the Mod Editor]]
*[[Publishing to the Steam Workshop|Publishing your mod to the Steam Workshop]]

=== Tutorials ===
*[[Tutorials/Creating Your First Mod|Creating your first mod]]
*[[Tutorials/Building A Board Mod|Building a board mod]]
*[[Tutorials/Building A Minigame Mod|Building a minigame mod]]
</div>

<div class="main-page-section">

==Mod Editor Windows==
Learn about the different windows that make up the Mod Editor.
{| class="wikitable"
|-
| '''Primary Windows'''
| [[Hierarchy Window]] - [[Inspector Window]] - [[Scene View]] - [[Asset Browser]] - [[Log Window]]
|-
| '''Other Windows'''
| [[Action Editor]] - [[Mod Validator|Mod Validator Window]] - [[Publishing to the Steam Workshop|Publish Window]] - [[Published Mods Window]]
|-
|}
</div>

<div class="main-page-section">

==Other Concepts==
These are some other miscellaneous concepts that are useful to know when creating mods.

'''General'''
* [[Mod Settings|Adjusting Mod Settings]]
* [[Unlocked Mod|Marking a published mod as Unlocked]]
* [[Mod Editor Shortcuts]]

'''Advanced'''
* [[Custom Board Space|Creating Custom Board Spaces]]
* [[Lighting Settings]]
* [[Screen Effects]]
</div>
</div>

<div>
<div class="main-page-section">

== Components ==
[[Component]]s are blocks of logic that are added to [[Gameobject]]s to give them unique functionality.
{| class="wikitable"
|-
| '''[[:Category:Gameplay Components|Gameplay]]'''
|-
| style="padding-left: 2em;" | '''General'''
| [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]
|-
| style="padding-left: 2em;" | '''Minigame only'''
| [[Item Component|Item]] - [[AI Navigation Node Component|AI Navigation Node]] - [[Logic Component|Logic]] - [[Player Spawn Component|Player Spawn]] - [[Spawner Component|Spawner]] - [[Trigger Component|Trigger]] - [[Weapon Component|Weapon]]
|-
| style="padding-left: 2em;" | '''Board only'''
| [[Board Space Component|Board Space]] - [[Board Space Event Component|Board Space Event]]
|-
| '''[[:Category:Rendering Components|Rendering]]'''
| [[Light Component|Light]] - [[Line Renderer Component|Line Renderer]] - [[Mesh Renderer Component|Mesh Renderer]] - [[Particle System Component|Particle System]] - [[Prop Component|Prop]] - [[Text Component|Text]] - [[Water Component|Water]]
|-
| '''[[:Category:Audio Components|Audio]]'''
| [[Audio Source Component| Audio Source]]
|-
| '''[[:Category:Physics Components|Physics]]'''
| [[Box Collider Component|Box Collider]] - [[Capsule Collider Component|Capsule Collider]] - [[Mesh Collider Component|Mesh Collider]] - [[Sphere Collider Component|Sphere Collider]]
|-
| '''Other'''
| [[Transform Component|Transform]] - [[Prefab Instance Component|Prefab Instance]] - [[Note Component|Note]]
|}
</div>

<div class="main-page-section">

== Assets ==
[[:Category:Assets|Assets]] are objects used in the creation of mods.
{| class="wikitable"
|-
| '''Assets'''
| [[Mesh Asset]] - [[Texture Asset]] - [[Audio Clip Asset]] - [[Material Asset]] - [[Prefab Asset]]
|-
| '''Importing Assets'''
| [[Importing Audio]] - [[Importing Images]] - [[Importing Models]]
|}
</div>

<div class="main-page-section">

== Actions ==
[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an [[Event]] is fired.
{| class="wikitable"
|-
| '''Minigame Logic'''
| [[Change Health Action]] - [[Change Player Velocity Action]] - [[Change Score Action]] - [[Drop Minigame Item Action]] - [[Give Minigame Item Action]] - [[Modify Player Action]] - [[Set Gravity Action]] - [[Set Placement Action]] - [[Stun Player Action]]
|-
| '''Board Logic'''
| [[Display Popup Action]] - [[Damage Player Action]] - [[Drop Keys Action]] - [[Give Item Action]] - [[Give Keys Action]] - [[Give Trophy Action]] - [[Heal Player Action]] - [[Move To Space Action]] - [[Set Board Space Active Action]] - [[Set Connection Active Action]] - [[Spawn Keys Action]]
|-
| '''Utility'''
|[[Kill Action]] - [[Play Sound Action]] - [[Set Active Action]] - [[Spawn Prefab Action]] - [[Wait Action]]
|-
| '''Movement'''
| [[Match Transform Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]]
|-
| '''Visuals'''
| [[Set Color Action]] - [[Set Player Visual Action]] - [[Spawn Effect Action]] - [[Show Message Action]]
|-
|}
</div>
</div>

</div>

Main Page

2023-08-21T03:16:27Z

RBAdmin: /* Mod Editor Windows */

__NOTOC__
'''Welcome to the Pummel Party Mod Editor Documentation'''

Using the Mod Editor you can create your own Minigames and Board Maps for Pummel Party.

<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
<div>
<div class="main-page-section">
== Getting started ==
If you're new to the mod editor, start here!
=== Information ===
*[[Introduction to the Mod Editor]]
*[[Publishing to the Steam Workshop|Publishing your mod to the Steam Workshop]]

=== Tutorials ===
*[[Tutorials/Creating Your First Mod|Creating your first mod]]
*[[Tutorials/Building A Board Mod|Building a board mod]]
*[[Tutorials/Building A Minigame Mod|Building a minigame mod]]
</div>

<div class="main-page-section">

==Mod Editor Windows==
Learn about the different windows that make up the Mod Editor.
{| class="wikitable"
|-
| '''Primary Windows'''
| [[Hierarchy Window]] - [[Inspector Window]] - [[Scene View]] - [[Asset Browser]] - [[Log Window]]
|-
| '''Other Windows'''
| [[Mod Validator|Mod Validator Window]] - [[Publishing to the Steam Workshop|Publish Window]] - [[Published Mods Window]] - [[Action Editor]]
|-
|}
</div>

<div class="main-page-section">

==Other Concepts==
These are some other miscellaneous concepts that are useful to know when creating mods.

'''General'''
* [[Mod Settings|Adjusting Mod Settings]]
* [[Unlocked Mod|Marking a published mod as Unlocked]]
* [[Mod Editor Shortcuts]]

'''Advanced'''
* [[Custom Board Space|Creating Custom Board Spaces]]
* [[Lighting Settings]]
* [[Screen Effects]]
</div>
</div>

<div>
<div class="main-page-section">

== Components ==
[[Component]]s are blocks of logic that are added to [[Gameobject]]s to give them unique functionality.
{| class="wikitable"
|-
| '''[[:Category:Gameplay Components|Gameplay]]'''
|-
| style="padding-left: 2em;" | '''General'''
| [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]
|-
| style="padding-left: 2em;" | '''Minigame only'''
| [[Item Component|Item]] - [[AI Navigation Node Component|AI Navigation Node]] - [[Logic Component|Logic]] - [[Player Spawn Component|Player Spawn]] - [[Spawner Component|Spawner]] - [[Trigger Component|Trigger]] - [[Weapon Component|Weapon]]
|-
| style="padding-left: 2em;" | '''Board only'''
| [[Board Space Component|Board Space]] - [[Board Space Event Component|Board Space Event]]
|-
| '''[[:Category:Rendering Components|Rendering]]'''
| [[Light Component|Light]] - [[Line Renderer Component|Line Renderer]] - [[Mesh Renderer Component|Mesh Renderer]] - [[Particle System Component|Particle System]] - [[Prop Component|Prop]] - [[Text Component|Text]] - [[Water Component|Water]]
|-
| '''[[:Category:Audio Components|Audio]]'''
| [[Audio Source Component| Audio Source]]
|-
| '''[[:Category:Physics Components|Physics]]'''
| [[Box Collider Component|Box Collider]] - [[Capsule Collider Component|Capsule Collider]] - [[Mesh Collider Component|Mesh Collider]] - [[Sphere Collider Component|Sphere Collider]]
|-
| '''Other'''
| [[Transform Component|Transform]] - [[Prefab Instance Component|Prefab Instance]] - [[Note Component|Note]]
|}
</div>

<div class="main-page-section">

== Assets ==
[[:Category:Assets|Assets]] are objects used in the creation of mods.
{| class="wikitable"
|-
| '''Assets'''
| [[Mesh Asset]] - [[Texture Asset]] - [[Audio Clip Asset]] - [[Material Asset]] - [[Prefab Asset]]
|-
| '''Importing Assets'''
| [[Importing Audio]] - [[Importing Images]] - [[Importing Models]]
|}
</div>

<div class="main-page-section">

== Actions ==
[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an [[Event]] is fired.
{| class="wikitable"
|-
| '''Minigame Logic'''
| [[Change Health Action]] - [[Change Player Velocity Action]] - [[Change Score Action]] - [[Drop Minigame Item Action]] - [[Give Minigame Item Action]] - [[Modify Player Action]] - [[Set Gravity Action]] - [[Set Placement Action]] - [[Stun Player Action]]
|-
| '''Board Logic'''
| [[Display Popup Action]] - [[Damage Player Action]] - [[Drop Keys Action]] - [[Give Item Action]] - [[Give Keys Action]] - [[Give Trophy Action]] - [[Heal Player Action]] - [[Move To Space Action]] - [[Set Board Space Active Action]] - [[Set Connection Active Action]] - [[Spawn Keys Action]]
|-
| '''Utility'''
|[[Kill Action]] - [[Play Sound Action]] - [[Set Active Action]] - [[Spawn Prefab Action]] - [[Wait Action]]
|-
| '''Movement'''
| [[Match Transform Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]]
|-
| '''Visuals'''
| [[Set Color Action]] - [[Set Player Visual Action]] - [[Spawn Effect Action]] - [[Show Message Action]]
|-
|}
</div>
</div>

</div>

Action Editor

2023-08-21T03:15:47Z

RBAdmin:

[[File:ActionEditorWindow.png|thumb|800px|The action editor window. In this example, actions are set up to make a cube move upwards over 4 seconds, with a message during and at the end.]]
The action editor is a window that allows [[Action]]s to be set for an [[Event]]. It can be accessed by clicking the "Edit" button on an event in the [[Inspector Window]].

Actions are executed from top to bottom. This doesn't affect most actions as they typically happen instantly. The main exception to this is the [[Wait Action]] which will delay the execution of all actions below it.

Not all actions are available at once. There are some actions that are only available in Board mods, while others are only available in Minigame Mods. Some actions are also restricted to certain events, such as all Board Actions being restricted to the events provided by the [[Board Space Event Component]].

The [[Display Popup Action]] is unique in that it will pause the execution of actions while the popup is being displayed. It also allows actions to be added to the different outcomes of the popup, creating nested action lists. The breadcrumb trail at the top of the action editor can be used to navigate these nested action lists. The remaining actions in a list will not be run until all actions in a popup's nested action list are complete.

Action Editor

2023-08-21T03:15:11Z

RBAdmin:

[[File:ActionEditorWindow.png|thumb|600px|The action editor window. In this example, actions are set up to make a cube move upwards over 4 seconds, with a message during and at the end.]]
The action editor is a window that allows [[Action]]s to be set for an [[Event]]. It can be accessed by clicking the "Edit" button on an event in the [[Inspector Window]].

Actions are executed from top to bottom. This doesn't affect most actions as they typically happen instantly. The main exception to this is the [[Wait Action]] which will delay the execution of all actions below it.

Not all actions are available at once. There are some actions that are only available in Board mods, while others are only available in Minigame Mods. Some actions are also restricted to certain events, such as all Board Actions being restricted to the events provided by the [[Board Space Event Component]].

The [[Display Popup Action]] is unique in that it will pause the execution of actions while the popup is being displayed. It also allows actions to be added to the different outcomes of the popup, creating nested action lists. The breadcrumb trail at the top of the action editor can be used to navigate these nested action lists. The remaining actions in a list will not be run until all actions in a popup's nested action list are complete.

Action Editor

2023-08-21T03:14:36Z

RBAdmin: Added more information

[[File:ActionEditorWindow.png|thumb|600px|The action editor window. Actions are set up to make a cube move upwards over 4 seconds, with a message during and at the end.]]
The action editor is a window that allows [[Action]]s to be set for an [[Event]]. It can be accessed by clicking the "Edit" button on an event in the [[Inspector Window]].

Actions are executed from top to bottom. This doesn't affect most actions as they typically happen instantly. The main exception to this is the [[Wait Action]] which will delay the execution of all actions below it.

Not all actions are available at once. There are some actions that are only available in Board mods, while others are only available in Minigame Mods. Some actions are also restricted to certain events, such as all Board Actions being restricted to the events provided by the [[Board Space Event Component]].

The [[Display Popup Action]] is unique in that it will pause the execution of actions while the popup is being displayed. It also allows actions to be added to the different outcomes of the popup, creating nested action lists. The breadcrumb trail at the top of the action editor can be used to navigate these nested action lists. The remaining actions in a list will not be run until all actions in a popup's nested action list are complete.

File:ActionEditorWindow.png

2023-08-21T03:10:09Z

RBAdmin: RBAdmin uploaded a new version of File:ActionEditorWindow.png

Main Page

2023-08-21T02:59:47Z

RBAdmin: /* Actions */ Updated to match the grouping of 1.13.0 Action Editor

__NOTOC__
'''Welcome to the Pummel Party Mod Editor Documentation'''

Using the Mod Editor you can create your own Minigames and Board Maps for Pummel Party.

<div style="display: grid; grid-template-columns: 48% 50%; column-gap: 2%">
<div>
<div class="main-page-section">
== Getting started ==
If you're new to the mod editor, start here!
=== Information ===
*[[Introduction to the Mod Editor]]
*[[Publishing to the Steam Workshop|Publishing your mod to the Steam Workshop]]

=== Tutorials ===
*[[Tutorials/Creating Your First Mod|Creating your first mod]]
*[[Tutorials/Building A Board Mod|Building a board mod]]
*[[Tutorials/Building A Minigame Mod|Building a minigame mod]]
</div>

<div class="main-page-section">

==Mod Editor Windows==
Learn about the different windows that make up the Mod Editor.
{| class="wikitable"
|-
| '''Primary Windows'''
| [[Hierarchy Window]] - [[Inspector Window]] - [[Scene View]] - [[Asset Browser]] - [[Log Window]]
|-
| '''Other Windows'''
| [[Mod Validator|Mod Validator Window]] - [[Publishing to the Steam Workshop|Publish Window]] - [[Published Mods Window]]
|-
|}
</div>

<div class="main-page-section">
==Other Concepts==
These are some other miscellaneous concepts that are useful to know when creating mods.

'''General'''
* [[Mod Settings|Adjusting Mod Settings]]
* [[Unlocked Mod|Marking a published mod as Unlocked]]
* [[Mod Editor Shortcuts]]

'''Advanced'''
* [[Custom Board Space|Creating Custom Board Spaces]]
* [[Lighting Settings]]
* [[Screen Effects]]
</div>
</div>

<div>
<div class="main-page-section">

== Components ==
[[Component]]s are blocks of logic that are added to [[Gameobject]]s to give them unique functionality.
{| class="wikitable"
|-
| '''[[:Category:Gameplay Components|Gameplay]]'''
|-
| style="padding-left: 2em;" | '''General'''
| [[Mover Component|Mover]] - [[Simple Animator Component|Simple Animator]]
|-
| style="padding-left: 2em;" | '''Minigame only'''
| [[Item Component|Item]] - [[AI Navigation Node Component|AI Navigation Node]] - [[Logic Component|Logic]] - [[Player Spawn Component|Player Spawn]] - [[Spawner Component|Spawner]] - [[Trigger Component|Trigger]] - [[Weapon Component|Weapon]]
|-
| style="padding-left: 2em;" | '''Board only'''
| [[Board Space Component|Board Space]] - [[Board Space Event Component|Board Space Event]]
|-
| '''[[:Category:Rendering Components|Rendering]]'''
| [[Light Component|Light]] - [[Line Renderer Component|Line Renderer]] - [[Mesh Renderer Component|Mesh Renderer]] - [[Particle System Component|Particle System]] - [[Prop Component|Prop]] - [[Text Component|Text]] - [[Water Component|Water]]
|-
| '''[[:Category:Audio Components|Audio]]'''
| [[Audio Source Component| Audio Source]]
|-
| '''[[:Category:Physics Components|Physics]]'''
| [[Box Collider Component|Box Collider]] - [[Capsule Collider Component|Capsule Collider]] - [[Mesh Collider Component|Mesh Collider]] - [[Sphere Collider Component|Sphere Collider]]
|-
| '''Other'''
| [[Transform Component|Transform]] - [[Prefab Instance Component|Prefab Instance]] - [[Note Component|Note]]
|}
</div>

<div class="main-page-section">

== Assets ==
[[:Category:Assets|Assets]] are objects used in the creation of mods.
{| class="wikitable"
|-
| '''Assets'''
| [[Mesh Asset]] - [[Texture Asset]] - [[Audio Clip Asset]] - [[Material Asset]] - [[Prefab Asset]]
|-
| '''Importing Assets'''
| [[Importing Audio]] - [[Importing Images]] - [[Importing Models]]
|}
</div>

<div class="main-page-section">

== Actions ==
[[:Category:Actions|Actions]] are used with gameplay components to perform tasks whenever an [[Event]] is fired.
{| class="wikitable"
|-
| '''Minigame Logic'''
| [[Change Health Action]] - [[Change Player Velocity Action]] - [[Change Score Action]] - [[Drop Minigame Item Action]] - [[Give Minigame Item Action]] - [[Modify Player Action]] - [[Set Gravity Action]] - [[Set Placement Action]] - [[Stun Player Action]]
|-
| '''Board Logic'''
| [[Display Popup Action]] - [[Damage Player Action]] - [[Drop Keys Action]] - [[Give Item Action]] - [[Give Keys Action]] - [[Give Trophy Action]] - [[Heal Player Action]] - [[Move To Space Action]] - [[Set Board Space Active Action]] - [[Set Connection Active Action]] - [[Spawn Keys Action]]
|-
| '''Utility'''
|[[Kill Action]] - [[Play Sound Action]] - [[Set Active Action]] - [[Spawn Prefab Action]] - [[Wait Action]]
|-
| '''Movement'''
| [[Match Transform Action]] - [[Play Tween Animation Action]] - [[Position Action]] - [[Rotation Action]] - [[Scale Action]]
|-
| '''Visuals'''
| [[Set Color Action]] - [[Set Player Visual Action]] - [[Spawn Effect Action]] - [[Show Message Action]]
|-
|}
</div>
</div>

</div>

File:BoardSpaceEventComponentExample.png

2023-08-21T02:51:01Z

RBAdmin: RBAdmin uploaded a new version of File:BoardSpaceEventComponentExample.png

== Summary ==
Example showing how a board space event component should be placed on a prefab root of a custom board space.

Board Space Component

2023-08-21T02:46:18Z

RBAdmin: /* Component Settings */ Updated with 1.13.0 content

The board space component is a [[:Category:Gameplay Components|gameplay component]] that creates a board space and its connections to other board spaces in a [[Board Mod]].

Board space components cannot be added to gameobjects that have child gameobjects in the hierarchy. They also cannot be used within prefabs.
Gameobjects with a board space component cannot have any child gameobjects added. They are given a unique icon and color in the hierarchy.

== Connecting Board Spaces ==
Board spaces 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 space to another existing board space, click the destination board spaces 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 space.

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

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

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

==Board Space Types==
[[File:BoardSpaceTypes.png|thumb|right|600px|The 8 different board space types, not including custom spaces.]]
There are eight types of board spaces provided, plus the Custom type which lets you select your own [[Custom Board Space]].
===Pathing Space===
This board space is invisible. It can take connections in and have connections out to other board spaces. Players cannot land on this space and passing one doesn't cost a step. Use these spaces to create more advanced paths between visible spaces, rather than a straight-line connection.
===Start Space===
This space is where the game will start. All players spawn on the start space. There must be exactly one start space per board mod. Nothing happens when landing on a start space.
===Heal Space===
The heal space will heal any player that lands on it by 10 health points.
===Gold Space===
The gold space rewards the player that landed on it with 5 keys.
===Hazard Space===
Landing on a hazard space will deal 5 health points of damage to the player.
===Item Space===
The item space gives any player who lands on it a single item.
===Recruit Space===
The first player to land on a recruit space can claim the space. They can decide between having the reaper:
* steal 9-12 health, damaging the player and healing the space owner.
* steal 6 keys, taking them from the player and giving them to the space owner.
When claiming a recruit space, all connected recruit spaces will also be claimed.
===Graveyard Space===
The graveyard space is a special space that is used when a player dies. You should include at least one graveyard space in a map for players to respawn at. Without this, players will respawn at the Start space. If there are multiple graveyards the player is respawned at the one furthest away from the trophy chest. Graveyard spaces cannot have incoming connections, only outgoing connections meant to put the player back onto the board.

===Custom Space===
You can create [[Custom Board Space|custom board spaces]] using prefabs. This is a slightly more advanced feature, but it can help make a board unique. These spaces use a set of [[Action]]s in a [[Board Space Event Component]] to define what happens when players land on them.

== Component Settings ==
[[File:BoardSpaceComponent.png|thumb|right|500px|The Board Space component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Type''' || The type of board space.
|-
| style="padding-left: 2em;" | '''Custom Space Prefab'''<br />''(Only for Type of "Custom")'' || The prefab that is used for this [[Custom Board Space]]. The list will be empty by default; add options through the board's [[Mod Settings]].
|-
| '''Supports Goal''' || If this board space is allowed to spawn the trophy chest or weapon cache.
|-
|'''Custom Goal Position''' || Should the location of the goal chest and weapons cache be set manually for this board space. If false, the game will choose the best spot based on the location and direction of other board spaces and connections. Not available for ''Pathing'' and ''Graveyard'' spaces, or when ''Supports Goal'' is false as these spaces cannot spawn the chest/weapons cache.
|-
| style="padding-left: 2em;" | '''Spawn Rotation''' || The direction around the board space to spawn the chest/weapons cache at.
|-
| style="padding-left: 2em;" | '''Spawn Distance''' || The distance from the board space to spawn the chest/weapons cache.
|-
|'''Start Disabled''' || When enabled, the board space will be disabled at the start of a game. It can be re-enabled during the game by using a [[Set Board Space Active Action]].
|-
|'''Outgoing Connections''' || A list of all connections leaving this board space. Here you can adjust their transition type.
|-
| style="padding-left: 2em;" | '''Player Transition''' || How the player should move along the connection. There are three options: ''Walk'', ''Jump'' and ''Teleport''.
|-
| style="padding-left: 4em;" | ''Walk'' || The player will walk from one board space to the next. This is the default behaviour.
|-
| style="padding-left: 4em;" | ''Jump'' || The player will perform a quick jumping animation from one board space to the next. This is useful if the board spaces are separated by a gap or are at different elevations.
|-
| style="padding-left: 4em;" | ''Teleport'' || The player will instantly teleport from one board space to the next. This mode hides the path between the spaces.
|-
| style="padding-left: 2em;" | '''Start Disabled''' || When enabled, the connection will be disabled at the start of a game. It can be re-enabled by using a [[Set Connection Active Action]].
|-
|}

An ''Align board space to ground'' button is available to quickly position and rotate the board space so that its centre is placed 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.

[[Category:Gameplay Components]]
[[Category:Components]]

File:BoardSpaceComponent.png

2023-08-21T02:35:55Z

RBAdmin: RBAdmin uploaded a new version of File:BoardSpaceComponent.png

Display Popup Action

2023-08-15T05:03:05Z

RBAdmin:

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:DisplayPopupAction.png|thumb|600px|The Display Popup action in the [[Action Editor]].]]
An action to display a popup window during a player's turn that they must interact with.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

A preview is shown within the action editor to give a rough idea of what the popup will look like in-game. This preview is only a guide, make sure to view it in play mode to ensure the text displays as expected.

[[File:DisplayPopupIngameExample.png|thumb|600px|right|How the example above appears ingame.]]

The buttons shown on the popup consist of the close button and 0, 1, 2, 3 or 4 choice buttons. The close button is always free to use and will simply close the popup. it can be disabled if you want to force the player to make a choice. The choice buttons can be used to run a set of actions when selected. They can be made to cost some resources to press. If the player doesn't have enough of the selected resource, they are unable to select the button. Choice buttons can also be free to press.

A choice button cannot be made to cost two types of resources to press. Only a single type of resource can be set as the cost of each button, but multiple of that same resource can be added. E.g. A button can't be made to cost 1 trophy and 1 key, but it can be made to cost 5 keys.

When a choice button is given a cost, an image of the currency (keys, health, trophy, etc) is shown beside the button text with an amount shown in the bottom corner. Eg if a button costs 10 keys to press, it will show the keys icon with a small "x10" text in the bottom corner. When an item is required to press a choice button, the icon for that specific item is shown.

== Customisation ==
The popup can be customised in various ways to suit the custom board.
Attributes that can be set include:
* The title of the popup
* The description/content of the popup
* The square speaker image on the popup
* Whether to show the close button or not
* The text on the close button
* The number of other buttons to display (up to 4)
* The text on the other buttons
* The cost to press the other buttons
* The small image icon that appears on each of the other buttons

{| class="wikitable"
|-
! Property !! Description
|-
|'''Title/Speaker Name''' || The text shown along the top of the popup. Use this to represent the title of the popup, or the name of the speaker if it's meant to represent a dialogue box.
|-
|'''Body Text''' || The text shown within the main area of the popup. use this to explain something to the player.
|-
|'''Speaker Icon''' || A texture representing the speaker or some other information related to the popup. The texture is shown in a square area so it should be a square image.
|-
|'''Choice buttons''' || The number of buttons the player is shown (in addition to the close button if enabled).
|-
| style="padding-left: 2em;" | '''Choice # Label''' || The text to display on the button. Keep this text short as there isn't much room.
|-
| style="padding-left: 2em;" | '''Cost of Choice #''' || The weapon fires discrete hitscan projectiles.
|-
| style="padding-left: 4em;" | ''None'' || The player is free to select this button. It will always be enabled.
|-
| style="padding-left: 4em;" | ''Key'' || The player must have and spend some number of keys to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Key)''' || The cost in keys to select this button.
|-
| style="padding-left: 4em;" | ''Health'' || The player must have and spend some number of health points to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Health)''' || How much HP to remove from the player when they press this button.
|-
| style="padding-left: 4em;" | ''Item'' || The player must have and spend some number of a given item to select this button.
|-
| style="padding-left: 6em;" | '''Item Cost''' || The specific item that the player must pay to press this button.
|-
| style="padding-left: 6em;" | '''Cost (Item)''' || How many of the chosen item must be spent to press this button.
|-
| style="padding-left: 4em;" | ''Trophy'' || The player must have and spend trophies to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Trophy) ''' || The cost in trophies to select this button.
|-
| '''Show Close Button''' || Whether or not to use the close button on this popup.
|-
| style="padding-left: 2em;" | '''Close Button Text''' || The text to display on the close button. Examples would be things like "Close", "Cancel", "No thanks", etc depending on the context of the popup.
|}

== Actions ==
Each button can be given a set of actions to run when the player selects it. This is done by adding actions to the "On Select" event of each choice. [[Display Popup Action]]s can be nested within these events, allowing for the creation of a simple, one-way dialogue tree.

If there are more actions to run below a Display Popup action in the action list, those actions will run after the popup has closed and any actions run by that popup have been completed.
If a popup is opened within a set of actions, the actions after the [[Display Popup Action]] will wait until the popup is closed before they are run.

== Example Usage ==
This action can be used to create a basic shop by showing a number of buttons that each cost some number of keys or other resources and run a [[Give Item Action]] when pressed.

Another use is to enable or disable paths through the board based on the player's choice. This could involve having a choice that uses a [[Set Connection Active Action]] to enable a new path just ahead of the player. Then once the player progresses into the new path, a separate Set Connection Active Action could disable the path behind them so that other players cannot follow.

A simpler implementation might use the [[Move To Space Action]] to simply teleport the player to a different space if they choose to.

Finally, a popup could be used that asks the player if they want to damage any players on a given set of spaces. This can force players to choose if they want to harm their friends or not, which is always a fun choice to make and can make the game more memorable!

[[Category:Actions]]

Pummel Party Mods:About

2023-08-15T05:01:14Z

RBAdmin: Created page with "This wiki contains information about the mod editor built into https://store.steampowered.com/app/880940/Pummel_Party/ Pummel Party. If you find any issues or unclear/outdated information on this wiki, please let us know via a post in the https://steamcommunity.com/app/880940/discussions/3/ Pummel Party Community Discussions on Steam. We hope you are able to use the Mod Editor to bring your ideas to life!"

This wiki contains information about the mod editor built into [[https://store.steampowered.com/app/880940/Pummel_Party/ Pummel Party]].

If you find any issues or unclear/outdated information on this wiki, please let us know via a post in the [[https://steamcommunity.com/app/880940/discussions/3/ Pummel Party Community Discussions]] on Steam.

We hope you are able to use the Mod Editor to bring your ideas to life!

Set Board Space Active Action

2023-08-15T01:37:12Z

RBAdmin: Added category

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:SetBoardSpaceActiveAction.png|thumb|600px|The Set Board Space Active action in the [[Action Editor]].]]
An action to enable, disable or toggle the active state of a board space.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

When a board space is disabled, it will act like a pathing space; players will freely walk through where it was and the space itself will be invisible. It will not cost a step to move through a disabled space, and any triggers on the space will not be run. A player cannot finish their turn by landing on a disabled space.

== Usage ==
Select the target for the action. This can be either ''This Board Space'', ''Advanced'' (which lets you choose any number of spaces), or both by selecting both of them.

If using advanced, choose all board spaces to target by adding them to the list that appears.

Select how each board space should be affected by the action:
* '''Disable''': If this board space is enabled, disable it. If it's already disabled, leave it disabled.
* '''Enable''': If this board space is disabled, enable it. If it's already enabled, leave it enabled.
* '''Toggle''': If this board space is disabled, enable it. If it's enabled, disable it.

== Notes ==
You can also use the [[Set Active Action]] to enable/disable board spaces. Setting the target to a board space will enable/disable the space. Setting the target to any gameobject that has board spaces and children will affect all child board spaces.

[[Category:Actions]]

Set Connection Active Action

2023-08-15T01:37:00Z

RBAdmin: Added category

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:SetConnectionActiveAction.png|thumb|600px|The Set Connection Active action in the [[Action Editor]].]]
An action to enable, disable or toggle the active state of a connection from one board space to another.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

Connections between board spaces can be turned on and off while a board is being played by using this action. This can be used to open or close different paths around the board.

== Usage ==
For the connection that you wish to edit, add the board space that the connection is outgoing from to the list under ''Board spaces to enable/disable/toggle connections on.''
All of that board space's outgoing connections will appear below. Now for each connection, select from each dropdown that appears how you want this action to affect it. The available options are:
* '''Do Nothing''': Leaves this connection as it is.
* '''Disable''': If this connection is enabled, disable it. If it's already disabled, leave it disabled.
* '''Enable''': If this connection is disabled, enable it. If it's already enabled, leave it enabled.
* '''Toggle''': If this connection is disabled, enable it. If it's enabled, disable it.

== Restrictions ==
* If the last outgoing connection from a board node is disabled using this action, one of the outgoing connections on that board space will be enabled at random to prevent a dead end from being created.

[[Category:Actions]]

Display Popup Action

2023-08-15T01:36:34Z

RBAdmin: Added category

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:DisplayPopupAction.png|thumb|600px|The Display Popup action in the [[Action Editor]].]]
An action to display a popup window during a player's turn that they must interact with.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

A preview is shown within the action editor to give a rough idea of what the popup will look like in-game. This preview is only a guide, make sure to view it in play mode to ensure the text displays as expected.

[[File:DisplayPopupIngameExample.png|thumb|600px|right|How the example above appears ingame.]]

The buttons shown on the popup consist of the close button and 0, 1, 2, 3 or 4 choice buttons. The close button is always free to use and will simply close the popup. it can be disabled if you want to force the player to make a choice. The choice buttons can be used to run a set of actions when selected. They can be made to cost some resources to press. If the player doesn't have enough of the selected resource, they are unable to select the button. Choice buttons can also be free to press.

A choice button cannot be made to cost two types of resources to press. Only a single type of resource can be set as the cost of each button, but multiple of that same resource can be added. Eg. A button can't be made to cost 1 trophy and 1 key, but it can be made to cost 5 keys.

When a choice button is given a cost, an image of the currency (keys, health, trophy, etc) is shown beside the button text with an amount shown in the bottom corner. Eg if a button costs 10 keys to press, it will show the keys icon with a small "x10" text in the bottom corner. When an item is required to press a choice button, the icon for that specific item is shown.

== Customisation ==
The popup can be customised in various ways to suit the custom board.
Attributes that can be set include:
* The title of the popup
* The description/content of the popup
* The square speaker image on the popup
* Whether to show the close button or not
* The text on the close button
* The number of other buttons to display (up to 4)
* The text on the other buttons
* The cost to press the other buttons
* The small image icon that appears on each of the other buttons

{| class="wikitable"
|-
! Property !! Description
|-
|'''Title/Speaker Name''' || The text shown along the top of the popup. Use this to represent the title of the popup, or the name of the speaker if it's meant to represent a dialogue box.
|-
|'''Body Text''' || The text shown within the main area of the popup. use this to explain something to the player.
|-
|'''Speaker Icon''' || A texture representing the speaker or some other information related to the popup. The texture is shown in a square area so it should be a square image.
|-
|'''Choice buttons''' || The number of buttons the player is shown (in addition to the close button if enabled).
|-
| style="padding-left: 2em;" | '''Choice # Label''' || The text to display on the button. Keep this text short as there isn't much room.
|-
| style="padding-left: 2em;" | '''Cost of Choice #''' || The weapon fires discrete hitscan projectiles.
|-
| style="padding-left: 4em;" | ''None'' || The player is free to select this button. It will always be enabled.
|-
| style="padding-left: 4em;" | ''Key'' || The player must have and spend some number of keys to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Key)''' || The cost in keys to select this button.
|-
| style="padding-left: 4em;" | ''Health'' || The player must have and spend some number of health points to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Health)''' || How much HP to remove from the player when they press this button.
|-
| style="padding-left: 4em;" | ''Item'' || The player must have and spend some number of a given item to select this button.
|-
| style="padding-left: 6em;" | '''Item Cost''' || The specific item that the player must pay to press this button.
|-
| style="padding-left: 6em;" | '''Cost (Item)''' || How many of the chosen item must be spent to press this button.
|-
| style="padding-left: 4em;" | ''Trophy'' || The player must have and spend trophies to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Trophy) ''' || The cost in trophies to select this button.
|-
| '''Show Close Button''' || Whether or not to use the close button on this popup.
|-
| style="padding-left: 2em;" | '''Close Button Text''' || The text to display on the close button. Examples would be things like "Close", "Cancel", "No thanks", etc depending on the context of the popup.
|}

== Actions ==
Each button can be given a set of actions to run when the player selects it. This is done by adding actions to the "On Select" event of each choice. [[Display Popup Action]]s can be nested within these events, allowing for the creation of a simple, one-way dialogue tree.

If there are more actions to run below a Display Popup action in the action list, those actions will run after the popup has closed and any actions run by that popup have been completed.
If a popup is opened within a set of actions, the actions after the [[Display Popup Action]] will wait until the popup is closed before they are run.

== Example Usage ==
This action can be used to create a basic shop by showing a number of buttons that each cost some number of keys or other resources and run a [[Give Item Action]] when pressed.

Another use is to enable or disable paths through the board based on the player's choice. This could involve having a choice that uses a [[Set Connection Active Action]] to enable a new path just ahead of the player. Then once the player progresses into the new path, a separate Set Connection Active Action could disable the path behind them so that other players cannot follow.

A simpler implementation might use the [[Move To Space Action]] to simply teleport the player to a different space if they choose to.

Finally, a popup could be used that asks the player if they want to damage any players on a given set of spaces. This can force players to choose if they want to harm their friends or not, which is always a fun choice to make and can make the game more memorable!

[[Category:Actions]]

Set Board Space Active Action

2023-08-15T01:35:05Z

RBAdmin: Added usage info

Set Connection Active Action

2023-08-15T01:33:52Z

RBAdmin:

Set Connection Active Action

2023-08-15T01:30:34Z

RBAdmin: Added info on usage

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:SetConnectionActiveAction.png|thumb|600px|The Set Connection Active action in the [[Action Editor]].]]
An action to enable, disable or toggle the active state of a connection from one board space to another.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

Connections between board spaces can be turned on and off while a board is being played by using this action. This can be used to open or close different paths around the board.

== Usage ==
For the connection that you wish to edit, add the board space that the connection is outgoing from to the list under ''Board spaces to enable/disable/toggle connections on.''
All of that board space's outgoing connections will appear below. Now for each connection, select from each dropdown that appears how you want to edit it. The available options are:
* '''Do Nothing''': Leaves this connection as it is.
* '''Disable''': If this connection is enabled, disable it. If it's already disabled, leave it disabled.
* '''Enable''': If this connection is disabled, enable it. If it's already enabled, leave it enabled.
* '''Toggle''': If this connection is disabled, enable it. If it's enabled, disable it.

== Restrictions ==
* If the last outgoing connection from a board node is disabled using this action, one of the outgoing connections on that board space will be enabled at random to prevent a dead end from being created.

File:SetBoardSpaceActiveAction.png

2023-08-15T01:22:27Z

RBAdmin:

File:SetConnectionActiveAction.png

2023-08-15T01:22:18Z

RBAdmin:

Display Popup Action

2023-08-15T01:15:16Z

RBAdmin: Added example usages

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:DisplayPopupAction.png|thumb|600px|The Display Popup action in the [[Action Editor]].]]
An action to display a popup window during a player's turn that they must interact with.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

A preview is shown within the action editor to give a rough idea of what the popup will look like in-game. This preview is only a guide, make sure to view it in play mode to ensure the text displays as expected.

[[File:DisplayPopupIngameExample.png|thumb|600px|right|How the example above appears ingame.]]

The buttons shown on the popup consist of the close button and 0, 1, 2, 3 or 4 choice buttons. The close button is always free to use and will simply close the popup. it can be disabled if you want to force the player to make a choice. The choice buttons can be used to run a set of actions when selected. They can be made to cost some resources to press. If the player doesn't have enough of the selected resource, they are unable to select the button. Choice buttons can also be free to press.

A choice button cannot be made to cost two types of resources to press. Only a single type of resource can be set as the cost of each button, but multiple of that same resource can be added. Eg. A button can't be made to cost 1 trophy and 1 key, but it can be made to cost 5 keys.

When a choice button is given a cost, an image of the currency (keys, health, trophy, etc) is shown beside the button text with an amount shown in the bottom corner. Eg if a button costs 10 keys to press, it will show the keys icon with a small "x10" text in the bottom corner. When an item is required to press a choice button, the icon for that specific item is shown.

== Customisation ==
The popup can be customised in various ways to suit the custom board.
Attributes that can be set include:
* The title of the popup
* The description/content of the popup
* The square speaker image on the popup
* Whether to show the close button or not
* The text on the close button
* The number of other buttons to display (up to 4)
* The text on the other buttons
* The cost to press the other buttons
* The small image icon that appears on each of the other buttons

{| class="wikitable"
|-
! Property !! Description
|-
|'''Title/Speaker Name''' || The text shown along the top of the popup. Use this to represent the title of the popup, or the name of the speaker if it's meant to represent a dialogue box.
|-
|'''Body Text''' || The text shown within the main area of the popup. use this to explain something to the player.
|-
|'''Speaker Icon''' || A texture representing the speaker or some other information related to the popup. The texture is shown in a square area so it should be a square image.
|-
|'''Choice buttons''' || The number of buttons the player is shown (in addition to the close button if enabled).
|-
| style="padding-left: 2em;" | '''Choice # Label''' || The text to display on the button. Keep this text short as there isn't much room.
|-
| style="padding-left: 2em;" | '''Cost of Choice #''' || The weapon fires discrete hitscan projectiles.
|-
| style="padding-left: 4em;" | ''None'' || The player is free to select this button. It will always be enabled.
|-
| style="padding-left: 4em;" | ''Key'' || The player must have and spend some number of keys to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Key)''' || The cost in keys to select this button.
|-
| style="padding-left: 4em;" | ''Health'' || The player must have and spend some number of health points to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Health)''' || How much HP to remove from the player when they press this button.
|-
| style="padding-left: 4em;" | ''Item'' || The player must have and spend some number of a given item to select this button.
|-
| style="padding-left: 6em;" | '''Item Cost''' || The specific item that the player must pay to press this button.
|-
| style="padding-left: 6em;" | '''Cost (Item)''' || How many of the chosen item must be spent to press this button.
|-
| style="padding-left: 4em;" | ''Trophy'' || The player must have and spend trophies to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Trophy) ''' || The cost in trophies to select this button.
|-
| '''Show Close Button''' || Whether or not to use the close button on this popup.
|-
| style="padding-left: 2em;" | '''Close Button Text''' || The text to display on the close button. Examples would be things like "Close", "Cancel", "No thanks", etc depending on the context of the popup.
|}

== Actions ==
Each button can be given a set of actions to run when the player selects it. This is done by adding actions to the "On Select" event of each choice. [[Display Popup Action]]s can be nested within these events, allowing for the creation of a simple, one-way dialogue tree.

If there are more actions to run below a Display Popup action in the action list, those actions will run after the popup has closed and any actions run by that popup have been completed.
If a popup is opened within a set of actions, the actions after the [[Display Popup Action]] will wait until the popup is closed before they are run.

== Example Usage ==
This action can be used to create a basic shop by showing a number of buttons that each cost some number of keys or other resources and run a [[Give Item Action]] when pressed.

Another use is to enable or disable paths through the board based on the player's choice. This could involve having a choice that uses a [[Set Connection Active Action]] to enable a new path just ahead of the player. Then once the player progresses into the new path, a separate Set Connection Active Action could disable the path behind them so that other players cannot follow.

A simpler implementation might use the [[Move To Space Action]] to simply teleport the player to a different space if they choose to.

Finally, a popup could be used that asks the player if they want to damage any players on a given set of spaces. This can force players to choose if they want to harm their friends or not, which is always a fun choice to make and can make the game more memorable!

Display Popup Action

2023-08-15T01:02:45Z

RBAdmin: Added images

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:DisplayPopupAction.png|thumb|600px|The Display Popup action in the [[Action Editor]].]]
An action to display a popup window during a player's turn that they must interact with.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

A preview is shown within the action editor to give a rough idea of what the popup will look like in-game. This preview is only a guide, make sure to view it in play mode to ensure the text displays as expected.

[[File:DisplayPopupIngameExample.png|thumb|600px|right|How the example above appears ingame.]]

The buttons shown on the popup consist of the close button and 0, 1, 2, 3 or 4 choice buttons. The close button is always free to use and will simply close the popup. it can be disabled if you want to force the player to make a choice. The choice buttons can be used to run a set of actions when selected. They can be made to cost some resources to press. If the player doesn't have enough of the selected resource, they are unable to select the button. Choice buttons can also be free to press.

A choice button cannot be made to cost two types of resources to press. Only a single type of resource can be set as the cost of each button, but multiple of that same resource can be added. Eg. A button can't be made to cost 1 trophy and 1 key, but it can be made to cost 5 keys.

When a choice button is given a cost, an image of the currency (keys, health, trophy, etc) is shown beside the button text with an amount shown in the bottom corner. Eg if a button costs 10 keys to press, it will show the keys icon with a small "x10" text in the bottom corner. When an item is required to press a choice button, the icon for that specific item is shown.

== Customisation ==
The popup can be customised in various ways to suit the custom board.
Attributes that can be set include:
* The title of the popup
* The description/content of the popup
* The square speaker image on the popup
* Whether to show the close button or not
* The text on the close button
* The number of other buttons to display (up to 4)
* The text on the other buttons
* The cost to press the other buttons
* The small image icon that appears on each of the other buttons

{| class="wikitable"
|-
! Property !! Description
|-
|'''Title/Speaker Name''' || The text shown along the top of the popup. Use this to represent the title of the popup, or the name of the speaker if it's meant to represent a dialogue box.
|-
|'''Body Text''' || The text shown within the main area of the popup. use this to explain something to the player.
|-
|'''Speaker Icon''' || A texture representing the speaker or some other information related to the popup. The texture is shown in a square area so it should be a square image.
|-
|'''Choice buttons''' || The number of buttons the player is shown (in addition to the close button if enabled).
|-
| style="padding-left: 2em;" | '''Choice # Label''' || The text to display on the button. Keep this text short as there isn't much room.
|-
| style="padding-left: 2em;" | '''Cost of Choice #''' || The weapon fires discrete hitscan projectiles.
|-
| style="padding-left: 4em;" | ''None'' || The player is free to select this button. It will always be enabled.
|-
| style="padding-left: 4em;" | ''Key'' || The player must have and spend some number of keys to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Key)''' || The cost in keys to select this button.
|-
| style="padding-left: 4em;" | ''Health'' || The player must have and spend some number of health points to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Health)''' || How much HP to remove from the player when they press this button.
|-
| style="padding-left: 4em;" | ''Item'' || The player must have and spend some number of a given item to select this button.
|-
| style="padding-left: 6em;" | '''Item Cost''' || The specific item that the player must pay to press this button.
|-
| style="padding-left: 6em;" | '''Cost (Item)''' || How many of the chosen item must be spent to press this button.
|-
| style="padding-left: 4em;" | ''Trophy'' || The player must have and spend trophies to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Trophy) ''' || The cost in trophies to select this button.
|-
| '''Show Close Button''' || Whether or not to use the close button on this popup.
|-
| style="padding-left: 2em;" | '''Close Button Text''' || The text to display on the close button. Examples would be things like "Close", "Cancel", "No thanks", etc depending on the context of the popup.
|}

== Actions ==
Each button can be given a set of actions to run when the player selects it. More Display Popup actions can be added to each button to create a simple, one-way dialogue tree.

If a popup is opened within a set of actions, the actions after the [[Display Popup Action]] will wait until the popup is closed before they are run.

File:DisplayPopupIngameExample.png

2023-08-15T00:58:59Z

RBAdmin:

File:DisplayPopupAction.png

2023-08-15T00:58:45Z

RBAdmin:

Display Popup Action

2023-08-10T21:06:29Z

RBAdmin:

= NOTICE: This content is planned for a future update. Everything on this page is subject to change or may not be added at all. =

[[File:DisplayPopupAction.png|thumb|600px|The Display Popup action in the [[Action Editor]].]]
An action to display a popup window during a player's turn that they must interact with.

Should be used on a [[Board Space Event Component]]. Can only be used in [[Board Mod]]s.

A preview is shown within the action editor to give a rough idea of what the popup will look like in-game. This preview is only a guide, make sure to view it in play mode to ensure the text displays as expected.

The buttons shown on the popup consist of the close button and 0, 1, 2, 3 or 4 choice buttons. The close button is always free to use and will simply close the popup. it can be disabled if you want to force the player to make a choice. The choice buttons can be used to run a set of actions when selected. They can be made to cost some resources to press. If the player doesn't have enough of the selected resource, they are unable to select the button. Choice buttons can also be free to press.

A choice button cannot be made to cost two types of resources to press. Only a single type of resource can be set as the cost of each button, but multiple of that same resource can be added. Eg. A button can't be made to cost 1 trophy and 1 key, but it can be made to cost 5 keys.

When a choice button is given a cost, an image of the currency (keys, health, trophy, etc) is shown beside the button text with an amount shown in the bottom corner. Eg if a button costs 10 keys to press, it will show the keys icon with a small "x10" text in the bottom corner. When an item is required to press a choice button, the icon for that specific item is shown.

== Customisation ==
The popup can be customised in various ways to suit the custom board.
Attributes that can be set include:
* The title of the popup
* The description/content of the popup
* The square speaker image on the popup
* Whether to show the close button or not
* The text on the close button
* The number of other buttons to display (up to 4)
* The text on the other buttons
* The cost to press the other buttons
* The small image icon that appears on each of the other buttons

{| class="wikitable"
|-
! Property !! Description
|-
|'''Title/Speaker Name''' || The text shown along the top of the popup. Use this to represent the title of the popup, or the name of the speaker if it's meant to represent a dialogue box.
|-
|'''Body Text''' || The text shown within the main area of the popup. use this to explain something to the player.
|-
|'''Speaker Icon''' || A texture representing the speaker or some other information related to the popup. The texture is shown in a square area so it should be a square image.
|-
|'''Choice buttons''' || The number of buttons the player is shown (in addition to the close button if enabled).
|-
| style="padding-left: 2em;" | '''Choice # Label''' || The text to display on the button. Keep this text short as there isn't much room.
|-
| style="padding-left: 2em;" | '''Cost of Choice #''' || The weapon fires discrete hitscan projectiles.
|-
| style="padding-left: 4em;" | ''None'' || The player is free to select this button. It will always be enabled.
|-
| style="padding-left: 4em;" | ''Key'' || The player must have and spend some number of keys to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Key)''' || The cost in keys to select this button.
|-
| style="padding-left: 4em;" | ''Health'' || The player must have and spend some number of health points to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Health)''' || How much HP to remove from the player when they press this button.
|-
| style="padding-left: 4em;" | ''Item'' || The player must have and spend some number of a given item to select this button.
|-
| style="padding-left: 6em;" | '''Item Cost''' || The specific item that the player must pay to press this button.
|-
| style="padding-left: 6em;" | '''Cost (Item)''' || How many of the chosen item must be spent to press this button.
|-
| style="padding-left: 4em;" | ''Trophy'' || The player must have and spend trophies to select this button.
|-
| style="padding-left: 6em;" | '''Cost (Trophy) ''' || The cost in trophies to select this button.
|-
| '''Show Close Button''' || Whether or not to use the close button on this popup.
|-
| style="padding-left: 2em;" | '''Close Button Text''' || The text to display on the close button. Examples would be things like "Close", "Cancel", "No thanks", etc depending on the context of the popup.
|}

== Actions ==
Each button can be given a set of actions to run when the player selects it. More Display Popup actions can be added to each button to create a simple, one-way dialogue tree.

If a popup is opened within a set of actions, the actions after the [[Display Popup Action]] will wait until the popup is closed before they are run.