Photon Quantum 2.1.1

Properties | List of all members
Quantum.TriggerInfo2D Struct Reference

Info about a collision between a trigger and a non-trigger 2D physics colliders. More...

Properties

EntityRefEntity [get]
 The main entity involved in the collision. More...
 
UInt16? EntityShapeUserTag [get]
 The Shape2D.UserTag of the entity's shape involved in the collision. More...
 
Boolean IgnoreTrigger [get, set]
 If the collision should be ignored by the physics engine. More...
 
bool IsStatic [get]
 If the Entity is touching a static trigger collider. If so, Other has an EntityRef.None value and the static collider data can be accessed through StaticData. More...
 
EntityRefOther [get]
 The other entity involved in the collision if the Entity is NOT colliding with a static (check IsStatic). More...
 
UInt16?? OtherShapeUserTag [get]
 The Shape2D.UserTag of the other entity's shape involved in the collision. Returns default value if the this is a static collision. More...
 
StaticColliderData StaticData [get]
 The StaticColliderData of the static collider if the Entity is colliding with a static (check IsStatic). More...
 

Detailed Description

Info about a collision between a trigger and a non-trigger 2D physics colliders.

The info is taken from the perspective of the entity that has subscribed to the callback with PhysicsEngine2D.SetCallbacks.

If both entities involved in a collision have subscribed to this collision type callback, it will be called twice, each time carrying information from the perspective of one of the entities.

No collision is checked between two kinematic colliders that are both trigger or both non-trigger.

No detailed collision data (ContactPoint, ContactNormal and Penetration) is computed for trigger collisions. Use shape queries with the appropriate query options selected as an option.

See TriggerInfo3D for 3D trigger collisions and CollisionInfo2D for 2D non-trigger collisions.

Property Documentation

◆ IgnoreTrigger

Boolean Quantum.TriggerInfo2D.IgnoreTrigger
getset

If the collision should be ignored by the physics engine.

◆ IsStatic

bool Quantum.TriggerInfo2D.IsStatic
get

If the Entity is touching a static trigger collider. If so, Other has an EntityRef.None value and the static collider data can be accessed through StaticData.

if (info.IsStatic) { var otherStaticData = info.StaticData; } else { var otherEntity = info.Other; }

◆ Entity

EntityRef? Quantum.TriggerInfo2D.Entity
get

The main entity involved in the collision.

The info is taken from the perspective of this entity, which has subscribed to the callback with PhysicsEngine2D.SetCallbacks.

If both entities involved in a collision have subscribed to this collision type callback, it will be called twice, each time carrying information from the perspective of one of the entities.

◆ EntityShapeUserTag

UInt16? Quantum.TriggerInfo2D.EntityShapeUserTag
get

The Shape2D.UserTag of the entity's shape involved in the collision.

◆ Other

EntityRef? Quantum.TriggerInfo2D.Other
get

The other entity involved in the collision if the Entity is NOT colliding with a static (check IsStatic).

If the Entity is colliding with a static, Other has EntityRef.None value.

◆ OtherShapeUserTag

UInt16?? Quantum.TriggerInfo2D.OtherShapeUserTag
get

The Shape2D.UserTag of the other entity's shape involved in the collision. Returns default value if the this is a static collision.

◆ StaticData

StaticColliderData Quantum.TriggerInfo2D.StaticData
get

The StaticColliderData of the static collider if the Entity is colliding with a static (check IsStatic).