WoopWoop.Component Class Reference

Represents a component that can be attached to an entity in the game world. More...

Inheritance diagram for WoopWoop.Component:

Public Member Functions
void	Attach (Entity entity)
	Attaches the component to an entity.
virtual void	Awake ()
	Awake is called when the component is initialized, regardless of whether or not the script is enabled.
virtual void	Start ()
	Called when the component is started if it's enabled.
virtual void	Update (float deltaTime)
	Called every frame to update the component's state.
virtual void	OnEndOfFrame ()
	Called on the end of every frame.
virtual void	Stop ()
	Called when the component is removed.
virtual void	OnDrawGizmo ()
	Tells the renderer how to draw the object's editor gizmos.

Properties
Entity	entity [get, private set]
	The entity to which this component is attached.
Transform	transform [get]
	The transform of the entity to which this component is attached.
bool	Enabled = true [get, set]
	Determines whether the component is enabled.

Detailed Description

Represents a component that can be attached to an entity in the game world.

Member Function Documentation

Attach()

void WoopWoop.Component.Attach

(

Entity

entity

)

Attaches the component to an entity.

Parameters

entity

The entity to attach the component to.

Awake()

virtual void WoopWoop.Component.Awake ( )

virtual

Awake is called when the component is initialized, regardless of whether or not the script is enabled.

Reimplemented in WoopWoop.BoxCollider, WoopWoop.TrailRenderer, and WoopWoop.UI.Canvas.

OnDrawGizmo()

virtual void WoopWoop.Component.OnDrawGizmo ( )

virtual

Tells the renderer how to draw the object's editor gizmos.

Reimplemented in WoopWoop.BoxCollider, WoopWoop.PointCollider, and WoopWoop.UI.Canvas.

OnEndOfFrame()

virtual void WoopWoop.Component.OnEndOfFrame ( )

virtual

Called on the end of every frame.

Reimplemented in WoopWoop.Camera.

Start()

virtual void WoopWoop.Component.Start ( )

virtual

Called when the component is started if it's enabled.

Reimplemented in WoopWoop.Camera, and WoopWoop.TextureRenderer.

Stop()

virtual void WoopWoop.Component.Stop ( )

virtual

Called when the component is removed.

Reimplemented in WoopWoop.TextureRenderer.

Update()

virtual void WoopWoop.Component.Update ( float deltaTime )

virtual

Called every frame to update the component's state.

Reimplemented in WoopWoop.Camera, WoopWoop.PointCollider, WoopWoop.BasicShapeRenderer, WoopWoop.LineRenderer, WoopWoop.PolygonRenderer, WoopWoop.TextureRenderer, WoopWoop.TrailRenderer, WoopWoop.UI.Canvas, WoopWoop.UI.Button, WoopWoop.UI.Checkbox, WoopWoop.UI.ColorPicker, WoopWoop.UI.DropdownMenu, WoopWoop.UI.HorizontalGrid, WoopWoop.UI.VerticalGrid, WoopWoop.UI.Label, WoopWoop.UI.Slider, WoopWoop.UI.TextRenderer, WoopWoop.UI.UIBoundsComponent, and WoopWoop.UI.UIWindow.

Property Documentation

Enabled

bool WoopWoop.Component.Enabled = true

getset

Determines whether the component is enabled.

entity

Entity WoopWoop.Component.entity

getprivate set

The entity to which this component is attached.

transform

Transform WoopWoop.Component.transform

get

The transform of the entity to which this component is attached.

---

The documentation for this class was generated from the following file:

• ECS/Component.cs