stingray.Cloth object reference

Description

Represents an Apex Cloth actor.

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

Constructors and accessors

stingray.Unit.cloth() stingray.Unit.create_cloth()

Other related reference items

Physics

Functions

create_collision_plane ( self, point, normal ) : number Creates a collision plane that the cloth actor will collide with.

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 Object lifetimes and userdata binding, 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.

Other related reference items

stingray.Cloth.destroy_collision()

destroy_collision ( self, id ) Destroys a collision plane previously created with create_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 Object lifetimes and userdata binding, 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.

move_collision_plane ( self, id, point, normal ) Moves the specified collision plane to a new position and/or orientation.

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 Object lifetimes and userdata binding, 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.