Pummel Party Mod Documentation - User contributions [en]

Board Space Component

2022-12-09T03:23:53Z

RBDev: /* Component Settings */

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 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 than 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 a the player.
===Item Space===
The item space gives any player that 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. The player will respawn at once of these spaces. 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 they 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 Node Type''' ''(Only for Type of "Custom")'' || If ''Type'' is set to custom, this input allows you to choose which custom space to use. The list will be empty by default; add options through the board's [[Mod Settings]].
|-
| '''Block Goal Spawn''' || Stop this board space from ever spawning the trophy chest or weapon cache.
|-
|'''Custom Goal Spawn''' || 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 where other board spaces and connection are. Not available for ''Pathing'' and ''Graveyard'' spaces, as those cannot have 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.
|-
|'''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 two options ''Walk'' and ''Teleport''.
|-
| style="padding-left: 4em;" | ''Walk'' || The player will walk from one board space to the next. This is the default behavior.
|-
| 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.
|}

An ''Align to ground'' button is available to orient the board space 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]]

Board Mod

2022-12-09T02:31:09Z

RBDev: /* Requirements for board mods */

A board mod is a custom game board created using the mod editor. You can build a unique environment from provided 3D assets, or import your own. Place and connect board nodes to allow players to move through this environment as they play.

== Overview ==

=== Requirements for board mods ===
Boards must meet the following requirements:
* They contain a single '''Start space'''
* All board spaces are connected (so no disconnected sections, e.g. two separate loops of board spaces)
* All board spaces have an incoming connection from another board space (excluding graveyard spaces)
* All board spaces have at least one outgoing connection to another board space (No dead-ends).

The incoming connection rule is so that the player can always loop around to a chest. The outgoing rule is so the player always has somewhere to go.

Boards should also have the following for the best experience:
* A [[:Category:Physics Components|Collider]] or [[Prop Component]] with collision below all spaces and the paths between spaces.
** Without this, the player may be positioned in unexpected ways as the board is being played as they have no way of knowing where the floor beneath them is.
* At least one graveyard-type board space. This is where players respawn the killed.
** Without a graveyard space, players will respawn at the start space.

=== Tips for creating great board mods ===
* Create an interesting environment
* Choose a matching lighting preset, or create your own [[Lighting Settings#Custom Lighting|custom lighting]]
* Try to spread out the occurrence of the different board space types
** Conversely, add some larger sections of the same board space type to make the board interesting
* Add split paths to give choice to players
* Try not to place props in the way of the camera
** You can adjust the camera settings from the Board Settings object in the Hierarchy.
** You can playtest the mod in the mod editor to make sure players can be seen as they move around the board.
* Add a custom positions for the trophy chest
** You can see where the trophy chest will appear when a board node is selected. If this spot is not suitable or overlaps a prop, you can add a custom position through the inspector for that board node.

=== How to play board mods ===
Subscribe to the board mod through either the ingame mod browser or the steam workshop. By subscribing to a board mod from the steam workshop, you can select it when creating a game with the board gamemode. The board will appear in the list of game boards to choose from. Starting the game will put you into a game on the custom board.

== FAQ ==
'''Q.'''
Why are players floating after they die?
Why does the eggplant bomb fall through the ground?
Why don’t some items work properly?

'''A.'''
You likely don’t have any solid ground with the WorldGround layer. This is the layer used by players and items to know what is solid below them.
Any gameobjects used as the floor of your board should:
* Have a collider
* Be set to the WorldGround layer

Board Mod

2022-12-09T02:29:48Z

RBDev: Updated board mode requirements

A board mod is a custom game board created using the mod editor. You can build a unique environment from provided 3D assets, or import your own. Place and connect board nodes to allow players to move through this environment as they play.

== Overview ==

=== Requirements for board mods ===
Boards must meet the following requirements:
* They contain a single '''Start space'''
* All board spaces have an incoming connection from another board space (excluding graveyard spaces)
* All board spaces have at least one outgoing connection to another board space (No dead-ends).

The incoming connection rule is so that the player can always loop around to a chest. The outgoing rule is so the player always has somewhere to go.

Boards should also have the following for the best experience:
* A [[:Category:Physics Components|Collider]] or [[Prop Component]] with collision below all spaces and the paths between spaces.
** Without this, the player may be positioned in unexpected ways as the board is being played as they have no way of knowing where the floor beneath them is.
* At least one graveyard-type board space. This is where players respawn the killed.
** Without a graveyard space, players will respawn at the start space.

=== Tips for creating great board mods ===
* Create an interesting environment
* Choose a matching lighting preset, or create your own [[Lighting Settings#Custom Lighting|custom lighting]]
* Try to spread out the occurrence of the different board space types
** Conversely, add some larger sections of the same board space type to make the board interesting
* Add split paths to give choice to players
* Try not to place props in the way of the camera
** You can adjust the camera settings from the Board Settings object in the Hierarchy.
** You can playtest the mod in the mod editor to make sure players can be seen as they move around the board.
* Add a custom positions for the trophy chest
** You can see where the trophy chest will appear when a board node is selected. If this spot is not suitable or overlaps a prop, you can add a custom position through the inspector for that board node.

=== How to play board mods ===
Subscribe to the board mod through either the ingame mod browser or the steam workshop. By subscribing to a board mod from the steam workshop, you can select it when creating a game with the board gamemode. The board will appear in the list of game boards to choose from. Starting the game will put you into a game on the custom board.

== FAQ ==
'''Q.'''
Why are players floating after they die?
Why does the eggplant bomb fall through the ground?
Why don’t some items work properly?

'''A.'''
You likely don’t have any solid ground with the WorldGround layer. This is the layer used by players and items to know what is solid below them.
Any gameobjects used as the floor of your board should:
* Have a collider
* Be set to the WorldGround layer

Texture Asset

2022-12-08T20:41:54Z

RBDev: /* Using a custom minigame/board image */

A texture asset is a 2D image that can be used with materials to texture objects.

See [[Importing Images]] for guidance and settings available when importing texture assets.

Imported textures can be viewed in the [[Asset Browser]] in the ''Custom > Textures'' folder.

==Usage ==

=== Put a Texture on an object===

====Using a material====
Textures must be assigned to a custom [[Material Asset]]. In Pummel Party, textures are not applied to objects directly, materials are applied to objects, and the material use a texture to define what they should look like. The different types of [[Material Asset]]s can take different sets of textures to create the materials look. If you just want to display a texture on an object, the texture that should be set is the one named ''Albedo''. This is the primary visible texture that is displayed when the material is used on an object.

The other textures that a material can use are for advanced graphical effects, such as [https://en.wikipedia.org/wiki/Normal_mapping Normal Mapping]. See the [[Material Asset]] page for more details on the different texture types.

====Props that support custom textures====
[[File:PropsThatSupportTextures.png|thumb|600px|Only some of the provided props can display custom textures correctly.]]
Most of the provided objects that have flat colors aren't [https://en.wikipedia.org/wiki/UV_mapping UV Mapped] to support full textures so trying to use a custom material with a texture on them will just change their colors to some part of your texture, but not show the texture properly.

There are some props that do support textures. These are most of the basic primitive shapes.

The best props to show textures on are the following. You can search for these when setting the ''Prop'' field of a [[Prop Component]]. You can also find them in the [[Asset Browser]] and drag them into the [[Scene View]] to use them.
* Cube
* Plane
* Sphere
* Capsule
* Cylinder
* LowPolyQuad
* CustomBoardSpace

The following work when showing textures, but may not be the best
* LowPolyPyramid
* BevelCube
* BevelCylinder
* LowPolyCapsule
* LowPolyCylinder

Any custom meshes that you use should display custom textures correctly as long as the mesh has correct UV mapping. This means if you have a custom model with a matching set of textures, you can import the [[Mesh Asset]], import the textures, create a material to hold the textures and apply them to a prop using the mesh.

===Using a custom minigame/board preview image===
You can import a texture and use it for the minigame or board image that appears in the lobby or on the minigame loading scene/ruleset menu. This preview image can be set in the [[Mod Settings]] under ''Minigame Details'' or ''Board Details'' depending on the mod type.

[[Category:Assets]]

Texture Asset

2022-12-08T20:36:41Z

RBDev: Added much more detailed usage content

A texture asset is a 2D image that can be used with materials to texture objects.

See [[Importing Images]] for guidance and settings available when importing texture assets.

Imported textures can be viewed in the [[Asset Browser]] in the ''Custom > Textures'' folder.

==Usage ==

=== Put a Texture on an object===

====Using a material====
Textures must be assigned to a custom [[Material Asset]]. In Pummel Party, textures are not applied to objects directly, materials are applied to objects, and the material use a texture to define what they should look like. The different types of [[Material Asset]]s can take different sets of textures to create the materials look. If you just want to display a texture on an object, the texture that should be set is the one named ''Albedo''. This is the primary visible texture that is displayed when the material is used on an object.

The other textures that a material can use are for advanced graphical effects, such as [https://en.wikipedia.org/wiki/Normal_mapping Normal Mapping]. See the [[Material Asset]] page for more details on the different texture types.

====Props that support custom textures====
[[File:PropsThatSupportTextures.png|thumb|600px|Only some of the provided props can display custom textures correctly.]]
Most of the provided objects that have flat colors aren't [https://en.wikipedia.org/wiki/UV_mapping UV Mapped] to support full textures so trying to use a custom material with a texture on them will just change their colors to some part of your texture, but not show the texture properly.

There are some props that do support textures. These are most of the basic primitive shapes.

The best props to show textures on are the following. You can search for these when setting the ''Prop'' field of a [[Prop Component]]. You can also find them in the [[Asset Browser]] and drag them into the [[Scene View]] to use them.
* Cube
* Plane
* Sphere
* Capsule
* Cylinder
* LowPolyQuad
* CustomBoardSpace

The following work when showing textures, but may not be the best
* LowPolyPyramid
* BevelCube
* BevelCylinder
* LowPolyCapsule
* LowPolyCylinder

Any custom meshes that you use should display custom textures correctly as long as the mesh has correct UV mapping. This means if you have a custom model with a matching set of textures, you can import the [[Mesh Asset]], import the textures, create a material to hold the textures and apply them to a prop using the mesh.

===Using a custom minigame/board image===
You can import a texture and use it for the minigame or board image that appears in the lobby or on the minigame loading scene/ruleset menu. This preview image can be set in the [[Mod Settings]] under ''Minigame Details'' or ''Board Details'' depending on the mod type.

[[Category:Assets]]

File:PropsThatSupportTextures.png

2022-12-08T20:24:34Z

RBDev:

Mesh Asset

2022-12-08T00:51:38Z

RBDev:

A mesh asset is a 3D model that can be used by [[Mesh Renderer Component|mesh renderers]] and [[Prop Component|props]].

Custom meshes can be imported from an .obj file (see [[Importing Models]]). Imported Mesh Assets can be viewed in the [[Asset Browser]] in the ''Custom > Props'' folder.

[[Category:Assets]]

Audio Clip Asset

2022-12-08T00:49:50Z

RBDev:

Audio clips are sound files that can be used as music/ambient sound in mods, or played by an audio source compnent.

See [[Importing Audio]] for how to import custom audio clips. Imported Audio Clips can be viewed in the [[Asset Browser]] in the ''Custom > Audio'' folder.

The pummel party mod editor comes with several audio clips built in, ready for use. There is a selection of quick noises, background music and ambient tracks.

[[Category:Assets]]

Importing Audio

2022-12-08T00:49:18Z

RBDev:

The Pummel Party Mod Editor allows the import of custom files for your mod. Custom [[Audio Clip Asset]]s can be used to place music or sound effects in your mod. See below table for supported formats.

== Supported File Formats ==
{| class="wikitable"
|-
! Format !! Extension !! Information
|-
| WAV||''.wav''||Waveform Audio File Format.
|-
|}

== How To Import Custom Audio ==
[[File:import_asset_01.jpg|thumb|400px|The import asset button.]]
# Open the Mod Editor.
# Load a mod project from the file menu or create a new mod.
# At the bottom of the screen find the 'Asset Browser' window.
# In the file browser window you will see the 'Import Asset' button, click this.
# You will have the option of what type of asset to import, select 'Audio'.
# Using the windows file browser, navigate to the audio file you want to import.
# Your audio clip should now show up as a useable asset in the 'Asset Browser' window under the 'Custom/Audio' folder.

Prefab Asset

2022-12-08T00:48:03Z

RBDev:

A prefab is a collection of gameobjects formed into a sub-hierarchy that can be re-used. Changing a prefab will cause all instances of that prefab to be updated.

Prefabs can be viewed in the [[Asset Browser]] in the ''Custom > Prefabs'' folder.

==Creating a prefab==
===From the hierarchy ===
You can turn a group of gameobjects in the hierarchy into a prefab. This group must have a single parent gameobject that you can select; you can't multiselect gameobjects to turn into a prefab.
To create the prefab, select the parent gameobject and drag it from the [[Hierarchy Window]] into the [[Asset Browser]]. This will create a prefab containing the dragged gameobject sub-hierarchy.

===Directly from the Asset Browser===
In the asset browser right click and choose ''Create > Prefab''. This will create an empty prefab that you can add gameobjects and components to.

==Editing a prefab==
To edit a prefab, find it in the hierarchy and double click it.
You can also select it in the hierarchy or scene view so that it is visible in the [[Inspector Window]]. Here you can click the ''Edit Prefab'' button on the [[Prefab Instance Component]].

Alternatively you can locate it in the [[Asset Browser]] and double click it.

==Instantiating prefabs==

Prefabs can be instantiated in the scene by creating a [[Prefab Instance Component|Prefab Instance]] and setting the ''Prefab'' field to the prefab you'd like to use. This will place that prefab into the scene.

==Use cases==
===Re-using groups of gameobjects===
This is the primary usage of prefabs. If you build a house of out many gameobjects (walls, floors, doors, windows, decorations etc) and turn it into a prefab, you can then create many instances of that prefab through out the scene. If you then realize you forgot to add a back door to the house, you can update the prefab and all houses you've placed will update. If you hadn't used a prefab ,then you'd need to manually add a door to every house you'd placed.

===Usage by other components===
Some components such as the [[Item Component]] and [[Spawner Component]] require a prefab to be passed to them. The item uses this prefab as the visual object that the player can hold when using the item, and the spawner needs a prefab of objects for it to spawn.

[[Category:Assets]]

Material Asset

2022-12-08T00:47:21Z

RBDev:

Materials are assets that describe how a mesh should be drawn. It contains the visible characteristics of the mesh, including it's texture, color, normal, ambient and other maps, texture tiling and offset and emission properties.

Custom Material assets can be viewed in the [[Asset Browser]] in the ''Custom > Materials'' folder.

== Shaders ==
A shader describes what attributes a material has and how it should be rendered.
There are four shaders provided with the mod editor. Each can produce a different type of material and is suitable for a different task.
{| class="wikitable"
|-
! Shader !! Usage
|-
| '''Standard Shader''' || The default shader that should be used for most objects in the scene.
|-
| '''Custom Board Space Shader''' || Used to make materials for custom board spaces.
|-
| '''Particle Shader''' || Used to make custom particle materials for the [[Particle System Component]]. Can also be used by the [[Line Renderer Component]].
|-
| '''Particle Alpha Blend''' || Used to make semi-transparent particles for the [[Particle System Component]]. Can also be used by the [[Line Renderer Component]]. Uses different alpha blending that the ''Particle Shader''
|-
|}

===Standard Shader===
The default shader that should be used for most objects in the scene.
{| class="wikitable"
|-
! Property !! Description
|-
| '''Rendering Mode''' || How the object should be rendered.
|-
| '''Albedo''' || Albedo texture. This is the primary, colored texture displayed on objects using this material.
|-
| '''Color''' || A color tint to apply to the material.
|-
| '''Metallic''' (Texture2D) || A texture describing where the texture should be shiny, and where it should be matte. Only the red and alpha channels of this texture are used. Red is used for metallic and alpha is used for smoothness. Red pixel values of 1 are completely reflective while values of 0 are completely matte. Alpha values of 1 are smooth while 0 is rough.
|-
| '''Metallic''' (Float Slider) || How metallic/shiny this material is when not using the ''Metallic'' texture map. Higher values make the material more reflective.
|-
| '''Smoothness''' || How smooth (high values) or bumpy (low values) this material is when not using the ''Metallic'' texture map. Affects the way light reflects from the material.
|-
| '''Normal Map''' || A [https://en.wikipedia.org/wiki/Normal_mapping Normal map] to create perceived elevation on the material.
|-
| '''Height Map''' || A [https://docs.unity3d.com/2023.1/Documentation/Manual/StandardShaderMaterialParameterHeightMap.html height map] describing the elevation of the material. Should be a black and white texture, with values closer to white being higher.
|-
| '''Occlusion''' || An [https://docs.unity3d.com/2023.1/Documentation/Manual/StandardShaderMaterialParameterOcclusionMap.html occlusion map] texture to simulate ambient occlusion on the material.
|-
| '''Emission''' (Checkbox) || Should this material glow.
|-
| '''Emission Color''' || The color of the glow. If using an emission map, it's colors will be tinted with this color.
|-
| '''Emission''' (Texture2D) || [https://docs.unity3d.com/2023.1/Documentation/Manual/StandardShaderMaterialParameterEmission.html Emission map] describing the colors of the glow on this material.
|-
| '''Texture Tiling''' || How many times the texture should be tiled across the material on both the X and Y axis.
|-
| '''Texture Offset''' || A pair of floats from 0 to 1 describing how much the texture should be offset across the material on both X and Y axis.
|-
|}

===Custom Board Space Shader===
Materials created using this shader should only be applied to the custom board mod mesh.
{| class="wikitable"
|-
! Property !! Description
|-
| '''Texture Tiling''' || How many times the ''Albedo'' texture should be tiled across the material on both the X and Y axis.
|-
| '''Texture Offset''' || A pair of floats from 0 to 1 describing how much the texture should be offset across the material on both X and Y axis.
|-
| '''Albedo''' || Albedo texture. This is the primary, colored texture displayed on objects using this material.
|-
| '''Edge Color''' || The color of the edge of the board space.
|-
| '''Inside Color''' || The background color of the inside area of the board space. Visible behind the Albedo texture (if it has transparency).
|-
| '''Icon Color''' || A color tint to apply to the ''Albedo'' texture.
|-
| '''Metallic''' || How metallic/shiny this material is. Higher values make the material more reflective.
|-
| '''Smoothness''' || How smooth (high values) or bumpy (low values) this material is. Affects the way light reflects from the material.
|-
| '''Icon Scale''' || A multiplier to scale the icon texture.
|-
|}

===Particle Shader===
Materials created using this shader can be used by particle systems and line renderers. Works well for glowing, semi transparent particles.
{| class="wikitable"
|-
! Property !! Description
|-
| '''Tint Color''' || A color tint to apply to the ''Particle Texture''.
|-
| '''Particle Texture''' || Texture used by the particle.
|-
| '''Texture Tiling''' || How many times the texture should be tiled across the particle on both the X and Y axis.
|-
| '''Texture Offset''' || A pair of floats from 0 to 1 describing how much the texture should be offset across the particle on both X and Y axis.
|-
| '''Soft Particles Factor''' ||
|-
| '''Intensity''' || How intensely these particles glow.
|-
|}

===Particle Alpha Shader===
Materials created using this shader can be used by particle systems and line renderers. This is the shader you should use if your particles do not need to glow or be transparent.
{| class="wikitable"
|-
! Property !! Description
|-
| '''Tint Color''' || A color tint to apply to the ''Particle Texture''.
|-
| '''Particle Texture''' || Texture used by the particle.
|-
| '''Texture Tiling''' || How many times the texture should be tiled across the particle on both the X and Y axis.
|-
| '''Texture Offset''' || A pair of floats from 0 to 1 describing how much the texture should be offset across the particle on both X and Y axis.
|-
| '''Soft Particles Factor''' ||
|-
|}

[[Category:Assets]]

Texture Asset

2022-12-08T00:46:49Z

RBDev:

Particle System Component

2022-12-08T00:43:05Z

RBDev:

The Particle system component is a [[:Category:Rendering Components|rendering component]] that creates and manages particles. These particles can be used to create effects such as fire, smoke, rain, dust and many more.

== Component Settings ==
The particle system component uses the same modules as the particle System in the Unity game engine. See the [https://docs.unity3d.com/Manual/ParticleSystemModules.html Unity particle system documentation] for what all of the settings do. ''Note: Some fields may not be exposed in the Pummel Party Mod Editor.''

== Example Usage ==
Particle systems are incredibly powerful and can create a wide range of effects. The best way to find uses for it is just to experiment. You'll likely find a setting that gives you an idea for how you could make a cool or interesting effect.
[[File:ParticleSystemExampleStarfield.png|thumb|none|A starfield created using particle systems.]]

=== Combining particle systems===
[[File:CampfireParticleExample.gif|thumb|399px|right|Campfire in a forest created using multiple particle systems together.]]
Another important tip when trying to create engaging visuals is to layer multiple particle systems together. For Example, when making a fire particle system, think of all the different effects that you'd see in a real campfire. Of course there's the flames, but what about the smoke and the small embers that occasionally rise up then fade out. Include separate particle systems for those to make the effect more interesting. Apply this to every effect you make; what else can you add to really ''sell'' the effect you're trying to create.

[[Category:Rendering Components]]
[[Category:Components]]

Water Component

2022-12-08T00:30:39Z

RBDev: Added image

The Water Component is a [[:Category:Rendering Components|rendering component]] that creates a plane of low-poly water for use in mods.

The water surface is created from many squares that will move over time to simulate waves. A unique material is placed on the mesh that displays froth and changes color based on the depth of objects beneath the water to simulate the lighting effect water would have on those objects.

== Component Settings ==
[[File:WaterComponent.png|thumb|500px|right|The default values for the Water Component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
| '''Width''' || The number of squares on the X axis that make up the water surface.
|-
| '''Height''' || The number of squares on the Z axis that make up the water surface.
|-
| '''Cell Size''' || The side length of each square that makes up the water surface.
|-
| '''Deep Color''' || The color of the water wherever there is nothing submerged close to the surface.
|-
| '''Shallow Color''' || The color of the water wherever it is shallow due to objects just below the surface.
|-
| '''Froth Color''' || The color of the froth that appears around the edge of the water where it intersects objects.
|-
| '''Wave Height''' || The intensity of the simulated waves. There are no units for this value, but larger values lead to taller waves.
|-
| '''Wave Speed''' || The frequency of the simulated waves moving up and down.
|}

== Example ==

The water component is excellent for quickly creating an ocean. It's also suitable for creating rivers and lakes, if the colors are adjusted and the waves are lessened.
[[File:BeachWaterExample.jpg|thumb|400px|none|Water used as an ocean to create a beach scene.]]

It doesn't even need to be water. Since the color can be changed it can be used as lava or goo. The opacity of the colors can be set, so it can be made more transparent, or very opaque.
[[File:WaterExample_GooInSewer.jpg|thumb|400px|none|Water used as a toxic goo in a sewer scene.]]

[[Category:Rendering Components]]
[[Category:Components]]

File:WaterComponent.png

2022-12-08T00:29:43Z

RBDev:

Audio Source Component

2022-12-08T00:28:23Z

RBDev: Added image

The audio source component is an [[:Category:Audio Components|Audio Component]] that can play sound from a point in the scene. It can also play sounds with no in-world position, such as background music.

The component includes a button in the inspector to preview the sound relative to the camera's position. This can be used to hear how the component's settings will affect the sound without needing to enter play mode.

== Component Settings ==
[[File:AudioSourceComponent.png|thumb|right|500px|The Audio Source component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
| '' General''
|-
| '''Audio Source Type''' || The type of the audio source. Choose ''SFX'' for any sound that play in the scene and ''Music'' for any music tracks. This affects which volume settings will apply to this audio source.
|-
| '''Audio Clip''' || The audio clip or sound file to play.
|-
| ''Playing''
|-
| '''Play On Awake''' || The audio source will start playback as soon as the game starts.
|-
| '''Loop''' || Should the audio source play the audio clip on repeat once it has started.
|-
| '''Pitch''' || Adjust the pitch of the audio clip playback. This will also change the speed of playback, with higher pitches playing the sound faster and lower pitches taking longer to play.
|-
| ''Sound''
|-
| '''Volume''' || The loudness of the sound.
|-
| '''2D/3D Sound Blend''' || The ratio of the sound being played in "2D" vs "3D". 
2D sounds can be heard from anywhere and will be heard with no direction. I.e. the position of the audio source doesn't influence the sound. 
3D sounds can only be heard from within the max distance range of the Audio Source and the sound will appear to come from the position of the audio source in 3D space.
|-
| style="padding-left: 2em;" | '''Stereo panning''' || (2D sound only) How the sound should be split between the left and right ear.
*-1 is completely through the left ear.
*0 is balanced between the two ears.
*1 is completely through the right ear.
|-
| style="padding-left: 2em;" | '''Rolloff Mode''' || (3D sound only) How the volume of the sound should decrease off over time. The volume will follow this type of curve from the ''Min Distance'' to the ''Max Distance''.
|-
| style="padding-left: 2em;" | '''Min Distance''' || (3D sound only) The minimum distance before the volume begins to drop off. When closer than this distance the full volume is used. After this distance, the volume drops off according to the ''Rolloff Mode'' until the ''Max Distance''.
|-
| style="padding-left: 2em;" | '''Max Distance''' || (3D sound only) The maximum distance before the audio source cannot be heard anymore. (Note: When using ''Logarithmic'' rolloff mode, the audio will still be audible beyond this point, but will be extremely quiet).
|-
| style="padding-left: 2em;" | '''Use Doppler Effect''' || (3D sound only) Should this audio source use the [https://en.wikipedia.org/wiki/Doppler_effect Doppler Effect].
|}

== Example Usage ==
=== Playing spatial music or ambience ===
You can use the audio source to play music or ambience in one part of the scene. You could play the sound of frogs croaking near a pond, or some music near a radio, but set the 3D sound ''Max Distance'' small so that it drops off when not nearby.

If you instead want general looping background music or ambience that can be heard from everywhere, you can set these using the [[Mod Settings]].

=== Playing sound mid-game ===
You can make an audio source play while the game is running at a specific time by using a [[Play Sound Action]]. The play sound action will play a sound globally by default, but if you set the action's ''Target'' to ''Advanced'' and set an Audio Source as the advanced target, it will cause the audio source to play the sound, or cause the audio source to play its own sound if no clip is provided to the play sound action.

[[Category:Audio Components]]
[[Category:Components]]

File:AudioSourceComponent.png

2022-12-08T00:28:00Z

RBDev:

Prefab Instance Component

2022-12-08T00:22:41Z

RBDev: Added image and more content

[[File:PrefabInstanceComponent.png|thumb|right|500px|The Prefab Instance component in the [[Inspector Window]]. The '''Edit Prefab''' button opens the current prefab asset for editing.]]
The prefab instance component is a [[:Category:Gameplay Components|gameplay component]] that creates an instance of a given [[Prefab Asset]].

This is the primary way to use prefabs. The benefit of prefabs is to create the prefab once and use it many times throughout the scene without manually duplicating all objects within the prefab. Using prefabs with the Prefab Instance component allows you to make many prefab instances which all point to the same prefab asset. This means if the prefab asset changes, all prefab instances will update automatically.

Prefab Instance components cannot be added to gameobjects that have child gameobjects in the hierarchy. They must be added to an empty gameobject that has no other components attached.
While a prefab instance component is attached to a gameobject, that gameobject cannot have any child gameobjects added, cannot have any more components added and will be given a unique icon and color in the hierarchy.

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

File:PrefabInstanceComponent.png

2022-12-08T00:18:06Z

RBDev:

Mesh Collider Component

2022-12-08T00:14:45Z

RBDev: Added image

The mesh collider component is a [[:Category:Physics Components|Physics Component]] that creates an invisible, solid, volume from a provided mesh. The collider will only be solid on the outside faces of the given mesh.

== Component Settings ==
[[File:MeshColliderComponent.png|thumb|right|800px|The Mesh Collider component in the [[Inspector Window]] and [[Scene View]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Convex''' || Is this mesh convex? If the mesh is convex, tick this box to improve the collision detection of the mesh. If the mesh isn't convex (i.e. it's one sided), it will be made convex by adding depth so collision can occur on all sides.
|-
| '''Mesh''' || The 3D mesh to use as a collider.
|-

|-
|}
 
== Example Usage ==

=== Invisible objects ===
You may want to create an invisible platform as a challenge in a minigame.

[[Category:Physics Components]]
[[Category:Components]]

Sphere Collider Component

2022-12-08T00:14:41Z

RBDev: Added image

The sphere collider component is a [[:Category:Physics Components|Physics Component]] that creates an invisible, solid, spherical volume.

== Component Settings ==
[[File:SphereColliderComponent.png|thumb|right|800px|The Sphere Collider component in the [[Inspector Window]] and [[Scene View]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Center''' || The center of the sphere in local space.
|-
| '''Radius''' || The distance from the center of the sphere to the edge. Controls the size of the collider.
|-
|}
 
== Example Usage ==

=== Invisible objects ===
You may want to create an invisible platform as a challenge in a minigame.

=== Smoothing out collision on a complex object===
You may have an collection of [[Prop Component]] objects in the scene with complex collision that could have their collision disabled and replaced with a single or a few sphere colliders.

[[Category:Physics Components]]
[[Category:Components]]

File:SphereColliderComponent.png

2022-12-08T00:14:23Z

RBDev:

File:MeshColliderComponent.png

2022-12-08T00:14:15Z

RBDev:

Capsule Collider Component

2022-12-08T00:12:53Z

RBDev: Added image

The capsule collider component is a [[:Category:Physics Components|Physics Component]] that creates an invisible, solid, capsule-shaped volume.

== Component Settings ==
[[File:CapsuleColliderComponent.png|thumb|right|800px|The Capsule Collider component in the [[Inspector Window]] and [[Scene View]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Center''' || The center of the capsule volume.
|-
| '''Radius''' || Distance from the center of the capsule to the edge.
|-
| '''Height''' || Distance from the bottom of one curved end to the top of the other.
|-
| '''Direction''' || The "up" direction of the capsule. This is the axis that is affected by ''Height''.
|-
|}
 
== Example Usage ==

=== Invisible objects ===
You may want to create an invisible platform as a challenge in a minigame.

=== Smoothing out collision on a complex object===

You may have an collection of [[Prop Component]] objects in the scene with complex collision that could have their collision disabled and replaced with a single or a few capsule colliders.

[[Category:Physics Components]]
[[Category:Components]]

File:CapsuleColliderComponent.png

2022-12-08T00:12:18Z

RBDev:

Box Collider Component

2022-12-08T00:11:57Z

RBDev: Added image

The box collider component is a [[:Category:Physics Components|Physics Component]] that creates an invisible, solid, box-shaped volume.

== Component Settings ==
[[File:BoxColliderComponent.png|thumb|right|800px|The Box Collider component in the [[Inspector Window]] and [[Scene View]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Center''' || The center of the box volume.
|-
| '''Size''' || The width, height and depth of the box volume in local space.
|-
|}
 
== Example Usage ==
=== Level Boundaries ===
Box colliders are the perfect way to keep players within the bounds of the level. It is recommended to use a visible object instead of an invisible wall, but if you want to make sure players don't escape over the top of a visible wall, you can place a box collider that extends much higher than the visible wall's collider.

=== Invisible objects ===
You may want to create an invisible platform as a challenge in a minigame.

=== Smoothing out collision on a complex object===
[[File:SmoothBridgeUsingColliders.png|thumb|right|Here this bridge has had it's collision disabled and replaced with three box colliders. This allows players to smoothly traverse the bridge. Without this, the player would bounce up and down on each plank of the bridge.]]
You may have an object in the scene with complex collision, or holes in the object that players should not enter. Use a box collider to cover these areas to improve and simplify collision.

[[Category:Physics Components]]
[[Category:Components]]

File:BoxColliderComponent.png

2022-12-08T00:10:32Z

RBDev:

Mesh Renderer Component

2022-12-08T00:04:11Z

RBDev: Added image

The mesh renderer is a [[:Category:Rendering Components|rendering component]] that renders a 3D mesh in the scene. It can render both built-in and custom [[Mesh Asset]]s

== Component Settings ==
[[File:MeshRendererComponent.png|thumb|right|600px|The Mesh Renderer component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
| '''Cast Shadows''' || Should shadows be cast from the ''Mesh''.
|-
| style="padding-left: 2em;" | ''Off'' || The mesh will not cast any shadows.
|-
| style="padding-left: 2em;" | ''On'' || The mesh will cast shadows.
|-
| style="padding-left: 2em;" | ''Two Sided'' || The mesh will cast shadows. It will cast shadows from both sides of each polygon that makes up the visible model.
|-
| style="padding-left: 2em;" | ''Shadows Only'' || Only the shadows cast by the mesh will be visible. The mesh will not be visible.
|-
| '''Mesh''' || The [[Mesh Asset|mesh]] or prop asset to be drawn by the renderer.
|-
| '''Materials''' || A list of materials to draw the mesh with.
|}

[[Category:Rendering Components]]
[[Category:Components]]

File:MeshRendererComponent.png

2022-12-08T00:02:32Z

RBDev:

Line Renderer Component

2022-12-08T00:00:26Z

RBDev: Moved and resized image

The Line Renderer is a [[:Category:Rendering Components|rendering component]] that can create a 3D line through the scene. It is primarily used for adding interesting visual effects and detail to a mod.

== Component Settings ==
[[File:LineRendererWithInspector.png|thumb|800px|right|An example of a line renderer component and how it appears in the [[Scene View]]. The custom material uses the ''Particle Alpha Blend'' shader]]

{| class="wikitable"
|-
! Property !! Description
|-
|'''Positions''' || An ordered list of positions. The line is constructed by connecting these points together.
|-
| '''Loop''' || Connects the last position back to the first.
|-
| '''Use World Space''' || Makes the positions relative to the world origin, rather than this gameobject's transform position.
|-
| '''Start Width''' || The width of the line at the first position.
|-
| '''End Width''' || The width of the line at the last position.
|-
| '''Corner Vertices''' || How smooth the corners in the line should be. Higher numbers lead to smoother corners.
|-
| '''End Vertices''' || How smooth the ends of the line should be. Higher numbers lead to smoother ends.
|-
| '''Start Color''' || The color of the line at the start position. ''Some materials don't support setting a color''.
|-
| '''End Color''' || The color of the line at the last position. ''Some materials don't support setting a color''.
|-
| '''Alignment''' || Determines if this light source will cast shadows and whether they will have a soft or hard edge.
|-
| style="padding-left: 2em;" | ''View'' || The line will always try to face the camera.
|-
| style="padding-left: 2em;" | ''Transform Z'' || The line will always try to face the +Z axis of the gameobject's transform.
|-
| '''Texture Mode''' || How the texture of this material should be drawn onto the line. ''Some materials don't support textures''.
|-
| style="padding-left: 2em;" | ''Stretch'' || Stretches the texture along the length of the line. The texture doesn't repeat.
|-
| style="padding-left: 2em;" | ''Tile'' || Tiles the texture along the length of the line. The tiling is controlled by the texture tiling value of the material. ''Some materials don't support texture tiling''.
|-
| style="padding-left: 2em;" | ''Distribute Per Segment'' || Stretches the texture once along the length of the line. The texture will be stretched equally between each point, rather than evenly across the entire line.
|-
| style="padding-left: 2em;" | ''Repeat Per Segment'' || Stretches the texture between each position on the line, repeating along the length of the line.
|-
| '''Materials''' || A list of materials used by the line.
|-
| '''Cast Shadows''' || Should the line cast shadows.
|-
| style="padding-left: 2em;" | ''Off'' || The line will not cast any shadows.
|-
| style="padding-left: 2em;" | ''On'' || The line will cast shadows from the visible side.
|-
| style="padding-left: 2em;" | ''Two Sided'' || The line will cast shadows from both sides.
|-
| style="padding-left: 2em;" | ''Shadows Only'' || The line will not be visible, only its shadow will.
|-
| '''Receive Shadows''' || Should the line receive shadows from other objects that cast shadows.
|}

== Example Usage ==
[[File:LineRendererExample.png|thumb|right|300px|Here line renderers have been used to make moving lasers for the player to avoid.]]
Possible uses for line renderers include:
* A rope
* Power lines
* Lightning bolts
* Lasers
* Rainbows
* A path (A winding carpet or a bridge made of energy/magic/light)

[[Category:Rendering Components]]
[[Category:Components]]

Light Component

2022-12-07T23:56:43Z

RBDev: /* Component Settings */

The Light component is a [[:Category:Rendering Components|rendering component]] that provides light to the scene. This light will affect the shading of [[Prop Component|props]] and other objects in the scene.

== Component Settings ==
[[File:LightComponent.png|thumb|right|500px|The Light component in the [[Inspector Window]]. This example creates a wide, slightly yellow, spotlight.]]
{| class="wikitable"
|-
! Property !! Description
|-
| '''Type''' || The shape of the light.
|-
| style="padding-left: 2em;" | ''Point'' || Like a light bulb, shines light out in all directions from a single point.
|-
| style="padding-left: 2em;" | ''Spot'' || Shaped like a spot light, projecting light from a single point out in a cone shape.
|-
| style="padding-left: 2em;" | ''Directional'' || Similar to the sun, shines light from a given direction.
|-
| '''Color''' || The color of the shading applied by the light source.
|-
| '''Range''' ''Point and Spot only'' || The distance the light source will effect objects.
|-
| '''Spot Angle''' ''Spot only'' || The angle defining the spread of the spotlight from edge to edge.
|-
| '''Intensity''' || The brightness of the light source.
|-
| '''Shadows''' || Determines if this light source will cast shadows and whether they will have a soft or hard edge.
|-
| style="padding-left: 2em;" | ''None'' || Light does not produce shadows.
|-
| style="padding-left: 2em;" | ''Hard'' || Light produces shadows with hard, crisp edges.
|-
| style="padding-left: 2em;" | ''Soft'' || Light produces shadows with soft, blurred edges.
|}

== Example Usage ==
Let's say for example we have the following scene containing a prop of a camp fire. In order to show the camp fire is lit we might add a light source.

[[File:light_ex_01.jpg|frame|none]]

==== Adding a light source to our scene ====
# Right click on the camp fire in the hierarchy window on the left side of the mod editor screen.
# In the context menu that opens move your mouse to 'Light'.
# Click on 'Point Light' from the options of lights.
# You should now have a light source under your camp fire, click on the lights gizmo icon and move the light slightly up.
# While selecting the light game object, look in the inspector window on the right side of the mod editor.
# Find the 'Color' option and change it to orange.

We now have a light source under our campfire that makes it appear lit.
[[File:light_ex_02.jpg|frame|none]]

[[Category:Rendering Components]]
[[Category:Components]]

Light Component

2022-12-07T23:56:28Z

RBDev: /* Component Settings */

The Light component is a [[:Category:Rendering Components|rendering component]] that provides light to the scene. This light will affect the shading of [[Prop Component|props]] and other objects in the scene.

== Component Settings ==
[[File:LightComponent.png|thumb|right|500px|The Light component in the [[Inspector Window]]. This example creates a wide, slightly yellow, spotlight.]]
{| class="wikitable"
|-
! Property !! Description
|-
| '''Type''' || The shape of the light.
|-
| style="padding-left: 2em;" | ''Point'' || Like a light bulb, shines light out in all directions from a single point.
|-
| style="padding-left: 2em;" | ''Spot'' || Shaped like a spot light, projecting light from a single point out in a cone shape.
|-
| style="padding-left: 2em;" | ''Directional'' || Similar to the sun, shines light from a given direction.
|-
| '''Color''' || The color of the shading applied by the light source.
|-
| '''Range''' ''Point and Spot only'' || The distance the light source will effect objects.
|-
| '''Spot Angle''' ''Spot only'' || The angle defining the spread of the spotlight from edge to edge.
|-
| '''Intensity''' || The brightness of the light source.
|-
| '''Shadows''' || Determines if this light source will cast shadows and whether they will have a soft or hard edge).
|-
| style="padding-left: 2em;" | ''None'' || Light does not produce shadows.
|-
| style="padding-left: 2em;" | ''Hard'' || Light produces shadows with hard, crisp edges.
|-
| style="padding-left: 2em;" | ''Soft'' || Light produces shadows with soft, blurred edges.
|}

== Example Usage ==
Let's say for example we have the following scene containing a prop of a camp fire. In order to show the camp fire is lit we might add a light source.

[[File:light_ex_01.jpg|frame|none]]

==== Adding a light source to our scene ====
# Right click on the camp fire in the hierarchy window on the left side of the mod editor screen.
# In the context menu that opens move your mouse to 'Light'.
# Click on 'Point Light' from the options of lights.
# You should now have a light source under your camp fire, click on the lights gizmo icon and move the light slightly up.
# While selecting the light game object, look in the inspector window on the right side of the mod editor.
# Find the 'Color' option and change it to orange.

We now have a light source under our campfire that makes it appear lit.
[[File:light_ex_02.jpg|frame|none]]

[[Category:Rendering Components]]
[[Category:Components]]

Light Component

2022-12-07T23:56:14Z

RBDev: Added image and updated content

The Light component is a [[:Category:Rendering Components|rendering component]] that provides light to the scene. This light will affect the shading of [[Prop Component|props]] and other objects in the scene.

== Component Settings ==
[[File:LightComponent.png|thumb|right|500px|The Light component in the [[Inspector Window]]. This example creates a wide, slightly yellow, spotlight.]]
{| class="wikitable"
|-
! Property !! Description
|-
| '''Type''' || The shape of the light.
|-
| style="padding-left: 2em;" | ''Point'' || Like a light bulb, shines light out in all directions from a single point.
|-
| style="padding-left: 2em;" | ''Spot'' || Shaped like a spot light, projecting light from a single point out in a cone shape.
|-
| style="padding-left: 2em;" | ''Directional'' || Similar to the sun, shines light from a given direction.
|-
| '''Color''' || The color of the shading applied by the light source.
|-
| '''Range''' ''Point and Spot only'' || The distance the light source will effect objects (for directional lights this has no effect).
|-
| '''Spot Angle''' ''Spot only'' || The angle defining the spread of the spotlight from edge to edge.
|-
| '''Intensity''' || The brightness of the light source.
|-
| '''Shadows''' || Determines if this light source will cast shadows and whether they will have a soft or hard edge).
|-
| style="padding-left: 2em;" | ''None'' || Light does not produce shadows.
|-
| style="padding-left: 2em;" | ''Hard'' || Light produces shadows with hard, crisp edges.
|-
| style="padding-left: 2em;" | ''Soft'' || Light produces shadows with soft, blurred edges.
|}

== Example Usage ==
Let's say for example we have the following scene containing a prop of a camp fire. In order to show the camp fire is lit we might add a light source.

[[File:light_ex_01.jpg|frame|none]]

==== Adding a light source to our scene ====
# Right click on the camp fire in the hierarchy window on the left side of the mod editor screen.
# In the context menu that opens move your mouse to 'Light'.
# Click on 'Point Light' from the options of lights.
# You should now have a light source under your camp fire, click on the lights gizmo icon and move the light slightly up.
# While selecting the light game object, look in the inspector window on the right side of the mod editor.
# Find the 'Color' option and change it to orange.

We now have a light source under our campfire that makes it appear lit.
[[File:light_ex_02.jpg|frame|none]]

[[Category:Rendering Components]]
[[Category:Components]]

File:LightComponent.png

2022-12-07T23:54:59Z

RBDev:

Light Component

2022-12-07T23:49:21Z

RBDev: Removed navbox

The Light component is a [[:Category:Rendering Components|rendering component]] that provides light to the scene. This light will affect the shading of [[Prop Component|props]] and other objects in the scene.

== Component Settings ==
{| class="wikitable"
|-
! Property !! Description
|-
| '''Type''' || The shape of the light.
|-
| style="padding-left: 2em;" | ''Point'' || Like a light bulb, shines light out in all directions from a single point.
|-
| style="padding-left: 2em;" | ''Spot'' || Shaped like a spot light, projecting light from a single point out in a cone shape.
|-
| style="padding-left: 2em;" | ''Directional'' || Similar to the sun, shines light from a given direction.
|-
| '''Color''' || The color of the shading applied by the light source.
|-
| '''Range''' || The distance the light source will effect objects (for directional lights this has no effect).
|-
| '''Intensity''' || The brightness of the light source.
|-
| '''Shadows''' || Determines if this light source will cast shadows and whether they will have a soft or hard edge).
|-
| style="padding-left: 2em;" | ''None'' || Light does not produce shadows.
|-
| style="padding-left: 2em;" | ''Hard'' || Light produces shadows with hard, crisp edges.
|-
| style="padding-left: 2em;" | ''Soft'' || Light produces shadows with soft, blurred edges.
|}

== Example Usage ==
Let's say for example we have the following scene containing a prop of a camp fire. In order to show the camp fire is lit we might add a light source.

[[File:light_ex_01.jpg|frame|none]]

==== Adding a light source to our scene ====
# Right click on the camp fire in the hierarchy window on the left side of the mod editor screen.
# In the context menu that opens move your mouse to 'Light'.
# Click on 'Point Light' from the options of lights.
# You should now have a light source under your camp fire, click on the lights gizmo icon and move the light slightly up.
# While selecting the light game object, look in the inspector window on the right side of the mod editor.
# Find the 'Color' option and change it to orange.

We now have a light source under our campfire that makes it appear lit.
[[File:light_ex_02.jpg|frame|none]]

[[Category:Rendering Components]]
[[Category:Components]]

Template:Component Navbox

2022-12-07T23:41:19Z

RBDev:

<hr>
{| class="wikitable" style="width:100%"
|+ Components
| '''[[: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]]
|}

Template:Component Navbox

2022-12-07T23:40:17Z

RBDev:

{| class="wikitable" style="width:100%"
|+ Components
| '''[[: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]]
|}

Template:Component Navbox

2022-12-07T23:39:39Z

RBDev: Added full table

{| class="wikitable" style="margin:auto"
|+ Components
| '''[[: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]]
|}

Board Space Component

2022-12-07T22:35:51Z

RBDev: Added images and section explaining the different board space types

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 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 than 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 a the player.
===Item Space===
The item space gives any player that 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. The player will respawn at once of these spaces. 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 they 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 Node Type''' ''(Only for Type of "Custom")'' || If ''Type'' is set to custom, this input allows you to choose which custom space to use. The list will be empty by default; add options through the board's [[Mod Settings]].
|-
|'''Custom Goal Spawn''' || Should the location of the goal chest and weapons cache be set manually for this board space. If false, the game will choose the best spot based on where other board spaces and connection are. Not available for ''Pathing'' and ''Graveyard'' spaces, as those cannot have 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.
|}
For each connection on a board space, you can set the transition used to move players along that connection. ''Walk'' is the default and makes the player walk between the spaces, while ''Teleport'' will hide the path and teleport the player instantly between the spaces.

An ''Align to ground'' button is available to orient the board space 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

2022-12-07T22:32:26Z

RBDev:

File:BoardSpaceTypes.png

2022-12-07T22:28:40Z

RBDev:

Trigger Component

2022-12-07T22:04:40Z

RBDev: Added images and more content

The trigger component is a [[:Category:Gameplay Components|gameplay component]] that fires [[Event]]s when triggered. It will run any set [[Action]]s in response to those events.
It defines a trigger volume that is visible during editing of the mod, but is hidden in play mode.

== Component Settings ==
[[File:TriggerComponent.png|thumb|500px|right|The Trigger component in the [[Inspector Window]].]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Trigger Shape''' || The shape of the trigger volume.
|-
| style="padding-left: 2em;" | ''Box'' || The trigger is a box shape.
|-
| style="padding-left: 4em;" | '''Size''' || Describes the width height and depth of the trigger box.
|-
| style="padding-left: 2em;" | ''Sphere'' || The trigger is a sphere.
|-
| style="padding-left: 4em;" | '''Radius''' || Describes the width height and depth of the trigger box.
|-
| style="padding-left: 2em;" | ''Capsule'' || The trigger is a capsule shape.
|-
| style="padding-left: 4em;" | '''Radius''' || Distance from the center of the capsule to the edge.
|-
| style="padding-left: 4em;" | '''Height''' || Distance from the bottom of one curved end to the top of the other.
|-
| '''Trigger On Hit''' || If this trigger should fire when a weapon or punch collides with it. The trigger will be made solid when this is enabled and the other trigger types are disabled.
|-
| style="padding-left: 2em;" | '''On Hit Actions''' || Actions to perform when something hits the trigger's solid collider.
|-
| '''Trigger On Enter''' || If this trigger should fire when something enters its volume.
|-
| style="padding-left: 2em;" | '''On Enter Actions''' || Actions to perform when something enters the trigger volume.
|-
| '''Trigger On Exit''' || If this trigger should fire when something exits its volume.
|-
| style="padding-left: 2em;" | '''On Exit Actions''' || Actions to perform when something enters the trigger volume.
|-
| '''Trigger On Stay''' || If this trigger should fire repeatedly if something is within its volume.
|-
| style="padding-left: 2em;" | '''On Stay Actions''' || Actions to perform when something enters the trigger volume.
|-
| style="padding-left: 2em;" | '''Trigger Interval''' || Time in seconds between firing the On Stay event.
|-
| '''One Use Per Player''' || Should this trigger only fire once for each player in the game.
|-
| '''Disable After Triggered''' || Should this trigger disable itself after it is first triggered.

|}

== Example Usage ==
[[File:TriggerInSceneView.png|thumb|500px|right|The trigger as it appears in the [[Scene View]] when gizmos are enabled. Triggers are not visible in play mode; they are only visible while editing in the mod editor.]]

=== Damage area ===
By having a trigger's On Stay event damage the activator of the trigger, you can create an area for players to avoid by constantly removing health while they are in the trigger. You could have the trigger kill the player who entered it, and attach the trigger to a moving object for the player to avoid (think an obstacle course with swinging blades).

=== King of the hill ===
A king of the hill style game could be created by placing a trigger that rewards players for remaining inside it using actions with the ''On Stay'' event.

=== One use per player ===
Using the ''One Use Per Player'' attribute, you can make a trigger that can reward players with points, but stops players from repeatedly entering and exiting the trigger to gain many points.

=== Disable after triggered ===
''Disable After Triggered'' can allow a trigger to only be usable by a single player. This can be used in minigames where to goal is to reach something first to win. You can make entering a trigger finish the game and reward the player as the winner by having the minigame win condition set to "Obtain Points" and the trigger's ''On Enter'' Action rewarding the number of points to win the game.

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

File:TriggerInSceneView.png

2022-12-07T22:02:06Z

RBDev:

File:TriggerComponent.png

2022-12-07T22:01:01Z

RBDev:

Spawner Component

2022-12-07T21:57:27Z

RBDev: Added image

The spawner component is a [[:Category:Gameplay Components|gameplay component]] that can spawn [[Prefab Asset|prefabs]].

== Component Settings ==
[[File:SpawnerComponent.png|thumb|500px|The Spawner component in the [[Inspector Window]]. This example will spawn one of three prefabs at one of two locations, and not spawn another until the first is destroyed.]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Type''' || When should the spawner spawn something.
|-
| style="padding-left: 2em;" | ''Always Spawn'' || Spawns prefabs repeatedly.
|-
| style="padding-left: 4em;" | '''Interval''' || The time between each prefab being spawned by the spawner. Can be set as a constant or a random time between two values.
|-
| style="padding-left: 2em;" | ''Spawn On Destruction'' || Spawns a prefab once the last spawned prefab is destroyed.
|-
| style="padding-left: 4em;" | '''Delay''' || The ''Delay'' before the prefab is spawned when this spawner is destroyed. Can be set as a constant or a random time between two values.
|-
|'''Spawn Count''' || How many prefabs should be spawned at once.
|-
| '''Prefabs''' || A list of prefabs to spawn. The prefabs will be chosen randomly from this list.
|-
|'''Locations''' || Defines where prefabs are spawned.
|-
| style="padding-left: 2em;" | ''OnSpawner'' || Spawns prefabs on the position of this gameobject.
|-
| style="padding-left: 2em;" | ''OnTargets'' || Spawns prefabs on the provided list of ''Spawn Points''.
|-
| style="padding-left: 4em;" | '''Spawn Points''' || A list of transforms that will be used as spawn points for the prefabs.
|-
|}

== Example Usage ==
Spawners can be used to continuously spawn items or collectables for points.

Using ''Spawn on Destruction'' can essentially "respawn" a prefab once it's destroyed. Using the random mode of the spawn delay can make this use case more interesting.

Note: Be careful when using a low ''interval'' value with ''Always Spawn''. Many objects will be spawned in the same position and may cause the game to lag.

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

File:SpawnerComponent.png

2022-12-07T21:54:59Z

RBDev:

Player Spawn Component

2022-12-07T21:50:12Z

RBDev: Added images

The player spawn component is a [[:Category:Gameplay Components|gameplay component]] that defines where and how players should spawn. It is exclusive to [[Minigame Mod]]s.

== Component Settings ==
[[File:PlayerSpawnComponent.png|thumb|400px|The Player Spawn component in the [[Inspector Window]].]]
[[File:PlayerSpawnComponentPoint.png|thumb|400px|Point spawn type.]]
[[File:PlayerSpawnComponentLine.png|thumb|400px|Line spawn type.]]
[[File:PlayerSpawnComponentCircle.png|thumb|400px|Circle spawn type.]]
{| class="wikitable"
|-
! Property !! Description
|-
|'''Shared Spawn''' || Can this spawn point be shared by multiple players during the initial spawn.
|-
| '''Spawn Shape''' || The arrangement of player spawns when using Shared Spawn.
|-
| style="padding-left: 2em;" | ''Point'' || All players spawn on a single point.
|-
| style="padding-left: 2em;" | ''Line'' || Players spawn in a line. The length of the line can be set. Players can be made to spawn equally or randomly spaced along the line.
|-
| style="padding-left: 2em;" | ''Circle'' || Players spawn on the edge of a circle. The circle's radius can be set. Players can be made to spawn equally or randomly spaced around the circle.
|-
| '''Spawn Usage Type''' || The color of the shading applied by the light source.
|-
| style="padding-left: 2em;" | ''InitialSpawn'' || Players can spawn here at the start of the minigame.
|-
| style="padding-left: 2em;" | ''Respawn'' || Players can respawn here.
|-
| '''Allowed Players''' || The distance the light source will effect objects (for directional lights this has no effect).
|-
| '''Player Count Mask''' || Given the number of players in the current game, decide if this spawn point should be enabled. You can use this to create spawn points that are only used if there are, for example, 1, 2, 3 or 4 players. Then create other spawn points that are used instead for games of 5, 6, 7 and 8 players.
|}

== Example Usage ==
Spawn points are a requirement for minigames and define where the players will be placed at the start of the game.

Outside of just using them to place players initially, you can use the options to change how the minigame is played. By creating separate spawn points that only allow respawning, you can place players who have died into new areas that were inaccessible from the initial spawn location. Maybe this is somewhere high up that provides players with weapons to shoot at those who haven't died yet. Maybe it places them in a completely separate part of the scene to do something while they wait for the remaining players to die and the minigame to end. Maybe the point of a minigame is to try and die, allowing you to respawn at a place containing something that satisfies the win condition (A [[Trigger Component|trigger]] that gives you points for example).

You can use the ''Player Count Mask'' option to tailor your minigame to different player counts. If your minigame is an arena where players must battle, consider making a few arenas of different sizes, one for 1v1, one for 3 to 4 players and one for 5+ players. Creating spawn points in each of the three arenas with Player Count Masks set correctly will force players to spawn into the correct arena for the current game's player count.

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

File:PlayerSpawnComponentPoint.png

2022-12-07T21:48:56Z

RBDev:

File:PlayerSpawnComponentLine.png

2022-12-07T21:48:42Z

RBDev:

File:PlayerSpawnComponentCircle.png

2022-12-07T21:47:19Z

RBDev: