Cloth - stingray.Cloth object reference - Stingray Lua API Reference

stingray.Cloth object reference

Description

Represents an Apex Cloth actor.

This object exists only if the Stingray engine has been compiled with Apex support.

Functions

Parameters

self :

stingray.Cloth

Specifies the object instance that this function will act on.

You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

point :

stingray.Vector3

A point on the surface of the plane.

normal :

stingray.Vector3

The normal vector of plane.

Returns

number

The ID of the newly created collision plane.

Parameters

self :

stingray.Cloth

Specifies the object instance that this function will act on.

You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

id :

number

The ID of the collision plane to destroy.

Returns
This function does not return any values.
Parameters

self :

stingray.Cloth

Specifies the object instance that this function will act on.

You must always provide this self parameter when you call this function. You must use the dot . calling syntax, not the object-oriented colon : calling syntax.For more information, see this Stingray help topic, or this page in the Lua documentation.

id :

number

The ID of the collision plane to move.

point :

stingray.Vector3

A point on the surface of the plane at its new location.

normal :

stingray.Vector3

The normal vector of the plane in its new orientation.

Returns
This function does not return any values.