| Light Class |
This component implements a light source.
Inheritance HierarchySystemObject
GeonBit.ECS.ComponentsIComponent
GeonBit.ECS.ComponentsBaseComponent
GeonBit.ECS.Components.GraphicsLight
GeonBit.ECS.ComponentsIComponent
GeonBit.ECS.ComponentsBaseComponent
GeonBit.ECS.Components.GraphicsLight
Namespace: GeonBit.ECS.Components.Graphics
Assembly: GeonBit (in GeonBit.dll) Version: 1.0.0.0 (1.0.0.0)
SyntaxC#
public class Light : BaseComponent
The Light type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | _GameObject |
Get the game object this component is attached to.
(Inherited from BaseComponent.) |
| Color |
Light color and strength (A field = light strength).
|
| Direction |
Light direction, if its a directional light.
|
| Enabled |
Is this component currently enabled.
(Inherited from BaseComponent.) |
| Intensity |
Light Intensity (equivilent to Color.A).
|
| IsDirectionalLight |
Return if this light is a directional light.
|
| IsInfinite |
Return if this light source is infinite, eg has no range and reach anywhere (like a directional light).
|
| Name |
Get / set the name of this component.
(Inherited from IComponent.) |
| Range |
Light range.
|
| Specular |
Specular factor.
|
Methods| Name | Description | |
|---|---|---|
 | Clone |
Clone this component.
(Overrides BaseComponentClone.) |
| CollisionEnd |
Called when this physical body stop colliding with another body.
(Inherited from BaseComponent.) |
| CollisionProcess |
Called while this physical body is colliding with another body.
(Inherited from BaseComponent.) |
| CollisionStart |
Called when this physical body start colliding with another body.
(Inherited from BaseComponent.) |
| Destroy |
Destroy this component.
(Inherited from BaseComponent.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FixedUpdate |
Just like Update(), but called every constant amount of time regardless of FPS and Vsync.
(Inherited from BaseComponent.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetImplementedFrameBasedEvents |
Get a list of frame-based events this component implements.
(Inherited from BaseComponent.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasMethodImplemented |
Return if this component has a method implemented.
(Inherited from BaseComponent.) |
| Heartbeat |
An event that triggers every X miliseconds (defined per GameObject instance).
(Inherited from BaseComponent.) |
| RemoveFromParent |
Remove this component from parent.
(Inherited from BaseComponent.) |
| SendMessage |
Send message to this component.
(Inherited from BaseComponent.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update |
Update this component (called every frame parent is active).
(Inherited from BaseComponent.) |
Fields| Name | Description | |
|---|---|---|
 | AsDebug |
If true, it means this component was added to its parent in debug mode.
(Inherited from BaseComponent.) |
See Also