API reference
API reference
Select your platform
No SDKs available
No versions available

PhysicsConstraintBreakEventArgs Class

Extends EventArgs
Modifiers: final
Event arguments for physics constraint break events.
Fired when a constraint exceeds its breaking threshold and is destroyed.

Signature

class PhysicsConstraintBreakEventArgs(val breakingImpulse: Float, val dataModel: DataModel) : EventArgs

Constructors

PhysicsConstraintBreakEventArgs ( breakingImpulse , dataModel )
Signature
constructor(breakingImpulse: Float, dataModel: DataModel)
Parameters
breakingImpulse: Float  The impulse that caused the constraint to break.
dataModel: DataModel  The data model instance for event propagation

Properties

breakingImpulse : Float
[Get]
The impulse that caused the constraint to break.
Signature
val breakingImpulse: Float
dataModel : DataModel
[Get]
Data model.
Signature
val dataModel: DataModel
eventName : String
[Get]
The string identifier for this event type, used to match registered Entity event listeners. Each EventArgs subclass defines its own event name constant for dispatch routing.
Signature
val eventName: String
handled : Boolean
[Get][Set]
Flag indicating whether this event has been consumed by a listener. Set to true in an event handler to prevent further propagation to other listeners registered for the same event.
Signature
var handled: Boolean
throttleTime : Int?
[Get][Set]
Minimum interval in milliseconds between consecutive dispatches of this event type. Events fired more frequently than this interval are silently dropped to prevent listener overload.
Signature
var throttleTime: Int?

Companion Object

Properties

EVENT_NAME : String
[Get]
Signature
const val EVENT_NAME: String