BaseComponent Class

BaseComponent Class

A GameObject component API. A component is basically something you can attach to a GameObject, like physics, collision, sound effects, model, etc.

Inheritance Hierarchy

SystemObject
  GeonBit.ECS.ComponentsIComponent
    GeonBit.ECS.ComponentsBaseComponent
      More...

Namespace: GeonBit.ECS.Components
Assembly: GeonBit (in GeonBit.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

public abstract class BaseComponent : IComponent

The BaseComponent type exposes the following members.

Constructors

	Name	Description
	BaseComponent	Create the game component.

Properties

	Name	Description
	_GameObject	Get the game object this component is attached to.
	Count	Count how many Component instances currently exist. Note: 'Destroy' doesn't decrease the counter, only when the real class destrcutor is called (eg object is cleared from memory) counter is decreased.
	Enabled	Is this component currently enabled.
	Name	Get / set the name of this component. (Inherited from IComponent.)

Methods

	Name	Description
	Clone	Clone this component.
	CollisionEnd	Called when this physical body stop colliding with another body.
	CollisionProcess	Called while this physical body is colliding with another body.
	CollisionStart	Called when this physical body start colliding with another body.
	Destroy	Destroy this component.
	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.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetImplementedFrameBasedEvents	Get a list of frame-based events this component implements.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasMethodImplemented	Return if this component has a method implemented.
	Heartbeat	An event that triggers every X miliseconds (defined per GameObject instance).
	RemoveFromParent	Remove this component from parent.
	SendMessage	Send message to this component.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Update	Update this component (called every frame parent is active).

Fields

	Name	Description
	AsDebug	If true, it means this component was added to its parent in debug mode.

Inheritance Hierarchy