Class TriggerBehavior2D

Abstract base class for 2D trigger behaviors in the physics system.

Inheritance
object
IGameBehavior
PhysicsBehavior
TriggerBehavior2D
BoxTrigger2D
Inherited Members
Namespace: Genesis.Physics
Assembly: Genesis.dll
Syntax
public abstract class TriggerBehavior2D : PhysicsBehavior

Constructors

TriggerBehavior2D(PhysicHandler)

Initializes a new instance of the TriggerBehavior2D class with the specified physics handler.

Declaration
public TriggerBehavior2D(PhysicHandler handler)
Parameters
Type Name Description
PhysicHandler handler

The physics handler to associate with this trigger behavior.

Properties

Offset

Gets or sets the offset position for the trigger.

Declaration
public Vec3 Offset { get; set; }
Property Value
Type Description
Vec3

PhysicHandler

Gets or sets the physics handler associated with this trigger behavior.

Declaration
public PhysicHandler PhysicHandler { get; set; }
Property Value
Type Description
PhysicHandler

The PhysicHandler instance associated with this trigger behavior.

Trigger

Gets or sets the ghost object representing the trigger.

Declaration
public GhostObject Trigger { get; set; }
Property Value
Type Description
GhostObject

Methods

CreateTrigger(int, int)

Creates the trigger object using the specified physics handler.

Declaration
public abstract void CreateTrigger(int collisionGroup = -1, int collisionMask = -1)
Parameters
Type Name Description
int collisionGroup
int collisionMask

GetPhysicsObject()

Gets the physics object associated with this behavior.

Declaration
public override object GetPhysicsObject()
Returns
Type Description
object

The ghost object representing the trigger.
Overrides

GetPhysicsObject<T>()

Gets the physics object associated with this behavior, cast to the specified type.

Declaration
public override T GetPhysicsObject<T>()
Returns
Type Description
T

The ghost object representing the trigger, cast to the specified type.
Type Parameters
Name Description
T

The type to cast the physics object to.
Overrides

OnDestroy(Game, GameElement)

Called when the trigger is destroyed.

Declaration
public override void OnDestroy(Game game, GameElement parent)
Parameters
Type Name Description
Game game

The game instance.
GameElement parent

The parent game element.
Overrides

OnInit(Game, GameElement)

Called when the trigger is initialized.

Declaration
public override void OnInit(Game game, GameElement parent)
Parameters
Type Name Description
Game game

The game instance.
GameElement parent

The parent game element.
Overrides

OnRender(Game, GameElement)

Called when the trigger is rendered.

Declaration
public override void OnRender(Game game, GameElement parent)
Parameters
Type Name Description
Game game

The game instance.
GameElement parent

The parent game element.
Overrides

OnUpdate(Game, GameElement)

Updates the trigger's position and rotation each frame.

Declaration
public override void OnUpdate(Game game, GameElement parent)
Parameters
Type Name Description
Game game

The game instance.
GameElement parent

The parent game element.
Overrides

Rotate(Vec3)

Rotates the trigger by the specified vector.

Declaration
public virtual void Rotate(Vec3 value)
Parameters
Type Name Description
Vec3 value

The vector specifying the rotation values.

Rotate(float)

Rotates the trigger by the specified z value.

Declaration
public virtual void Rotate(float z)
Parameters
Type Name Description
float z

The rotation value around the z-axis.

Translate(Vec3)

Declaration
public virtual void Translate(Vec3 value)
Parameters
Type Name Description
Vec3 value

Translate(float, float)

Translates the trigger by the specified x and y values.

Declaration
public virtual void Translate(float x, float y)
Parameters
Type Name Description
float x

The translation value along the x-axis.
float y

The translation value along the y-axis.