Skip to content

niPlanarCollider⚓︎

This modifier makes particles bounce off of a rectangle.

This type inherits the following: niParticleCollider, niParticleModifier, niObject.

Properties⚓︎

collisionPoint⚓︎

Returns:

collisionTime⚓︎

Returns:

  • result (number)

controller⚓︎

Access to the generic time controller for particle systems.

Returns:

dieOnCollide⚓︎

If this flag is true a particle that collides with something will be destroyed.

Returns:

  • result (boolean)

height⚓︎

The plane size along the y axis.

Returns:

  • result (number)

next⚓︎

Access to the next attached modifier.

Returns:

planeEquation⚓︎

The coefficients in the point-normal form equation of the plane.

Returns:

position⚓︎

The center point of the collider.

Returns:

refCount⚓︎

Read-only. The number of references that exist for this object. When this value reaches zero, the object will be deleted.

Returns:

  • result (number)

restitution⚓︎

The fraction of the original amount of energy the particle retains after a collision.

Returns:

  • result (number)

RTTI⚓︎

Read-only. The runtime type information for this object. This is an alias for the .runTimeTypeInformation property.

Returns:

runTimeTypeInformation⚓︎

Read-only. The runtime type information for this object.

Returns:

spawnOnCollide⚓︎

This flag controls if a new particle will be spawned on a collision. The new particle is spawned at the position of the old particle with the same attributes.

Returns:

  • result (boolean)

width⚓︎

The plane size along the x axis.

Returns:

  • result (number)

xAxis⚓︎

The x axis, lying in the plane of the collider.

Returns:

yAxis⚓︎

The y axis, lying in the plane of the collider.

Returns:

Methods⚓︎

clone⚓︎

Creates a copy of this object.

local result = myObject:clone()

Returns:

isInstanceOfType⚓︎

Determines if the object is of a given type, or of a type derived from the given type.

local result = myObject:isInstanceOfType(type)

Parameters:

Returns:

  • result (boolean)

isOfType⚓︎

Determines if the object is of a given type.

local result = myObject:isOfType(type)

Parameters:

Returns:

  • result (boolean)

saveBinary⚓︎

Serializes the object, and writes it to the given file.

local success = myObject:saveBinary(path)

Parameters:

  • path (string): The path to write the file at, relative to the Morrowind installation folder. The .nif extension needs to be specified manually.

Returns:

  • success (boolean): If true the object was successfully serialized.