Light Component

From Pummel Party Mod Documentation
Revision as of 03:32, 9 November 2022 by RBDev (talk | contribs)
Jump to navigation Jump to search

The Light component is a rendering component that provides light to the scene. This light will affect the shading of props and other objects in the scene.

Component Settings

Property Description
Type The shape of the light.
Point Like a light bulb, shines light out in all directions from a single point.
Spot Shaped like a spot light, projecting light from a single point out in a cone shape.
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).
None Light does not produce shadows.
Hard Light produces shadows with hard, crisp edges.
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.

Light ex 01.jpg

Adding a light source to our scene

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

We now have a light source under our campfire that makes it appear lit.

Light ex 02.jpg



Components
Gameplay
General Mover - Simple Animator
Minigame only Item - AI Navigation Node - Logic - Player Spawn - Spawner - Trigger - Weapon
Board only Board Space - Board Space Event
Rendering Light - Line Renderer - Mesh Renderer - Particle System - Prop - Text - Water
Audio Audio Source
Physics Box Collider - Capsule Collider - Mesh Collider - Sphere Collider
Other Transform - Prefab Instance - Note