GetCollisionObjProperty

From GECK
Jump to: navigation, search


A function added by the JIP NVSE Plugin.

Description

Returns the value of a specified property of the collision object (if any) attached to the specified node in the calling reference's loaded 3D model.

Syntax

[help]
(propertyValue:float) reference.GetCollisionObjProperty nodeName:string propertyID:int{0-7}

Property IDs

0	Friction
1	Restitution
2	Linear Damping
3	Angular Damping
4	Inertia: X
5	Inertia: Y
6	Inertia: Z
7	Body Mass

Example

set fLinearDamping to objectRef.GetCollisionObjProperty "TumbleweedNV" 2 

Notes

  • Friction - Surface smoothness; how easily it slides along other bodies.
  • Restitution - Body bounciness; how much energy it has after colliding. Less than 1.0 loses energy; greater than 1.0 gains energy.
  • Linear Damping - Rate of linear deceleration. A value of 0.1 will remove 10% linear velocity every second.
  • Angular Damping - Rate of angular deceleration. A value of 0.05 will remove 5% angular velocity every second.
  • Inertia: X/Y/Z - Resistance to change in velocity or direction of motion (per axis) from external forces.
  • Body Mass - The body's mass in kg. A mass of zero represents an immovable object.

See Also