Impact Interaction System API
Impact.IInteractionData Interface Reference

Contains data relating to an interaction. More...

Inheritance diagram for Impact.IInteractionData:
Impact.InteractionData

Public Member Functions

IInteractionData Clone ()
 Create new interaction data with values copied from this interaction data. More...
 

Properties

int InteractionType [get, set]
 Integer representing the type of interaction such as Collision, Slide, Roll, and Simple. It is up to interactions to determine how this value affects the interaction. More...
 
Vector3 Velocity [get, set]
 The Velocity of the interaction. More...
 
Vector3 Point [get, set]
 The contact point at which the interaction occured. More...
 
Vector3 Normal [get, set]
 The normal of the surface where the interaction occured. More...
 
ImpactTagMaskTagMask [get, set]
 The tags retrieved from the object we are interacting with, represented as an integer bitmask. This can be null if we were not able to get the object being interacted with. More...
 
float CompositionValue [get, set]
 If using material composition, a 0 to 1 value representing the influence of the material at the contact point. More...
 
int? PriorityOverride [get, set]
 If specified, this will override the Priority value of the Impact Object. More...
 
GameObject ThisObject [get, set]
 The object these parameters are being sent from. More...
 
GameObject OtherObject [get, set]
 The object we are interacting with. More...
 

Detailed Description

Contains data relating to an interaction.

Member Function Documentation

◆ Clone()

IInteractionData Impact.IInteractionData.Clone ( )

Create new interaction data with values copied from this interaction data.

Implemented in Impact.InteractionData.

Property Documentation

◆ CompositionValue

float Impact.IInteractionData.CompositionValue
getset

If using material composition, a 0 to 1 value representing the influence of the material at the contact point.

Implemented in Impact.InteractionData.

◆ InteractionType

int Impact.IInteractionData.InteractionType
getset

Integer representing the type of interaction such as Collision, Slide, Roll, and Simple. It is up to interactions to determine how this value affects the interaction.

Implemented in Impact.InteractionData.

◆ Normal

Vector3 Impact.IInteractionData.Normal
getset

The normal of the surface where the interaction occured.

Implemented in Impact.InteractionData.

◆ OtherObject

GameObject Impact.IInteractionData.OtherObject
getset

The object we are interacting with.

Implemented in Impact.InteractionData.

◆ Point

Vector3 Impact.IInteractionData.Point
getset

The contact point at which the interaction occured.

Implemented in Impact.InteractionData.

◆ PriorityOverride

int? Impact.IInteractionData.PriorityOverride
getset

If specified, this will override the Priority value of the Impact Object.

Implemented in Impact.InteractionData.

◆ TagMask

ImpactTagMask? Impact.IInteractionData.TagMask
getset

The tags retrieved from the object we are interacting with, represented as an integer bitmask. This can be null if we were not able to get the object being interacted with.

Implemented in Impact.InteractionData.

◆ ThisObject

GameObject Impact.IInteractionData.ThisObject
getset

The object these parameters are being sent from.

Implemented in Impact.InteractionData.

◆ Velocity

Vector3 Impact.IInteractionData.Velocity
getset

The Velocity of the interaction.

Implemented in Impact.InteractionData.