Class DamageData

Data about damage applied to a destructable.

Index

Constructors

Properties

_damage _debrisPiece _direction _impulse _position _radius _sourceComponent

Accessors

damage debrisPiece direction impulse position radius sourceComponent

Methods

assign clone isEqual isEqual

Constructors

constructor

new DamageData(
    damage?: number,
    position?: Immutable<Vector3>,
    direction?: Immutable<Vector3>,
    impulse?: number,
    radius?: number,
    sourceComponent?: Component,
    debrisPiece?: SceneObject,
): DamageData
Parameters
- Optionaldamage: number
- Optionalposition: Immutable<Vector3>
- Optionaldirection: Immutable<Vector3>
- Optionalimpulse: number
- Optionalradius: number
- OptionalsourceComponent: Component
- OptionaldebrisPiece: SceneObject
Returns DamageData

Properties

`Protected`_damage

_damage: number

`Protected`_debrisPiece

_debrisPiece: SceneObject

`Protected`_direction

_direction: Vector3

`Protected`_impulse

_impulse: number

`Protected`_position

_position: Vector3

`Protected`_radius

_radius: number

`Protected`_sourceComponent

_sourceComponent: Component

Accessors

damage

get damage(): number

The amount of damage applied.

Returns number
set damage(value: number): void
Parameters
- value: number
Returns void

debrisPiece

get debrisPiece(): SceneObject

Optional debris piece that received the damage.

Returns SceneObject
set debrisPiece(value: SceneObject): void
Parameters
- value: SceneObject
Returns void

direction

get direction(): Vector3

The direction from which damage was applied (normalized).

Returns Vector3
set direction(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

impulse

get impulse(): number

The impulse force applied with the damage.

Returns number
set impulse(value: number): void
Parameters
- value: number
Returns void

position

get position(): Vector3

The world position where damage was applied.

Returns Vector3
set position(value: Immutable<Vector3>): void
Parameters
- value: Immutable<Vector3>
Returns void

radius

get radius(): number

The radius of the damage area.

Returns number
set radius(value: number): void
Parameters
- value: number
Returns void

sourceComponent

get sourceComponent(): Component

Optional component that caused the damage.

Returns Component
set sourceComponent(value: Component): void
Parameters
- value: Component
Returns void

Methods

assign

assign(other: Immutable<DamageData>): DamageData
Copies all properties defined by the prototype of DamageData from other to this instance.
Parameters
- other: Immutable<DamageData>
Returns DamageData

clone

clone(): DamageData

Clones this instance and returns a new DamageData with identical values.

Returns DamageData

isEqual

isEqual(this: Immutable<DamageData>, other: Immutable<DamageData>): boolean
Determines if this DamageData instance is equal to the other instance.
Parameters
- this: Immutable<DamageData>
- other: Immutable<DamageData>
Returns boolean

`Static`isEqual

isEqual(lhs: Immutable<DamageData>, rhs: Immutable<DamageData>): boolean
Determines if both DamageData instances are equal.
Parameters
- lhs: Immutable<DamageData>
- rhs: Immutable<DamageData>
Returns boolean