Visuals Class Reference

This class allows you to change visual aspects of an object, like rotation, color, etc. More...

Public Member Functions
void	SetLocalPosition (Context instigator, string transformId, Vector3 position)
	Snap a visual transform to a position.
void	SetLocalPosition (Context instigator, string transformId, Vector3 position, string callbackName)
	Snap a visual transform to a position.
void	SetLocalPosition (Context instigator, string transformId, Vector3 position, float duration)
	Snap a visual transform to a position.
void	SetLocalPosition (Context instigator, string transformId, Vector3 position, float duration, string callbackName)
	Snap a visual transform to a position.
void	SetLocalPositionFromTo (Context instigator, string transformId, Vector3 positionOne, Vector3 positionTwo, float duration)
	Move a visual transform to a position over time.
void	SetLocalPositionFromTo (Context instigator, string transformId, Vector3 positionOne, Vector3 positionTwo, float duration, string callbackName)
	Move a visual transform to a position over time.
void	SetLocalRotation (Context instigator, string transformId, Vector3 rotation)
	Snap a visual transform's rotation.
void	SetLocalRotation (Context instigator, string transformId, Vector3 rotation, string callbackName)
	Snap a visual transform's rotation, event fires on the rotation finishing.
void	SetLocalRotation (Context instigator, string transformId, Vector3 rotation, float duration)
	Change a visual transform's rotation over time.
void	SetLocalRotation (Context instigator, string transformId, Vector3 rotation, float duration, string callbackName)
	Change a visual transform's rotation over time, event fires on the rotation finishing.
void	SetLocalRotationFromTo (Context instigator, string transformId, Vector3 positionOne, Vector3 positionTwo, float duration)
	Change a visual transform's rotation over time between two pre-determined positions.
void	SetLocalRotationFromTo (Context instigator, string transformId, Vector3 positionOne, Vector3 positionTwo, float duration, string callbackName)
	Change a visual transform's rotation over time between two pre-determined positions, event fires on the rotation finishing.
void	SetContinousRotation (Context instigator, string transformId, Vector3 rotationRate)
	Sets a visual transform's continuous rotation speed.
void	StopContinousRotation (Context instigator, string transformId)
	Stop a visual transform's continus rotation.
void	SetEmissiveColor (Context instigator, string transformId, Color emissiveColor)
	Sets emissive color of all materials on a visual transform.
void	SetAlbedoColor (Context instigator, string transformId, Color albedoColor)
	Sets albedo color of all materials on a visual transform.
void	SetEnabled (Context instigator, string transformId, bool enabled)
	Sets the transform's Enabled status.

Detailed Description

This class allows you to change visual aspects of an object, like rotation, color, etc.

Member Function Documentation

SetAlbedoColor()

void SetAlbedoColor	(	Context	instigator,
		string	transformId,
		Color	albedoColor )

Sets albedo color of all materials on a visual transform.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
albedoColor	Color to set albedo value to. (Example: Color.White)

SetContinousRotation()

void SetContinousRotation	(	Context	instigator,
		string	transformId,
		Vector3	rotationRate )

Sets a visual transform's continuous rotation speed.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
rotationRate	The degrees per second of rotation for each axis. (Example: Vector:Create(90, 0, 0))

SetEmissiveColor()

void SetEmissiveColor	(	Context	instigator,
		string	transformId,
		Color	emissiveColor )

Sets emissive color of all materials on a visual transform.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
emissiveColor	Color to set emissive value to. (Example: Color.White)

SetEnabled()

void SetEnabled	(	Context	instigator,
		string	transformId,
		bool	enabled )

Sets the transform's Enabled status.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
enabled	Bool to set enabled value to. (Example: True)

SetLocalPosition() [1/4]

void SetLocalPosition	(	Context	instigator,
		string	transformId,
		Vector3	position )

Snap a visual transform to a position.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
position	The local position to move to.

SetLocalPosition() [2/4]

void SetLocalPosition	(	Context	instigator,
		string	transformId,
		Vector3	position,
		float	duration )

Snap a visual transform to a position.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
position	The local position to move to.
duration	The duration of this movement.

SetLocalPosition() [3/4]

void SetLocalPosition	(	Context	instigator,
		string	transformId,
		Vector3	position,
		float	duration,
		string	callbackName )

Snap a visual transform to a position.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
position	The local position to move to.
duration	The duration of this movement.
callbackName	The lua function name to call when the movement is finished

SetLocalPosition() [4/4]

void SetLocalPosition	(	Context	instigator,
		string	transformId,
		Vector3	position,
		string	callbackName )

Snap a visual transform to a position.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
position	The local position to move to.
callbackName	The lua function name to call when the movement is finished

SetLocalPositionFromTo() [1/2]

void SetLocalPositionFromTo	(	Context	instigator,
		string	transformId,
		Vector3	positionOne,
		Vector3	positionTwo,
		float	duration )

Move a visual transform to a position over time.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
positionOne	The local position to move from.
positionTwo	The local position to move to.
duration	The duration of this movement.

SetLocalPositionFromTo() [2/2]

void SetLocalPositionFromTo	(	Context	instigator,
		string	transformId,
		Vector3	positionOne,
		Vector3	positionTwo,
		float	duration,
		string	callbackName )

Move a visual transform to a position over time.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
positionOne	The local position to move from.
positionTwo	The local position to move to.
duration	The duration of this movement.
callbackName	The lua function name to call when the movement is finished

SetLocalRotation() [1/4]

void SetLocalRotation	(	Context	instigator,
		string	transformId,
		Vector3	rotation )

Snap a visual transform's rotation.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
rotation	The local rotation to snap to.

SetLocalRotation() [2/4]

void SetLocalRotation	(	Context	instigator,
		string	transformId,
		Vector3	rotation,
		float	duration )

Change a visual transform's rotation over time.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
rotation	The local rotation to move to.
duration	The duration of this movement.

SetLocalRotation() [3/4]

void SetLocalRotation	(	Context	instigator,
		string	transformId,
		Vector3	rotation,
		float	duration,
		string	callbackName )

Change a visual transform's rotation over time, event fires on the rotation finishing.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
rotation	The local rotation to move to.
duration	The duration of this movement.
callbackName	Lua function name to call when rotation has finished.

SetLocalRotation() [4/4]

void SetLocalRotation	(	Context	instigator,
		string	transformId,
		Vector3	rotation,
		string	callbackName )

Snap a visual transform's rotation, event fires on the rotation finishing.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
rotation	The local rotation to snap to.
callbackName	Lua function name to call when rotation has finished.

SetLocalRotationFromTo() [1/2]

void SetLocalRotationFromTo	(	Context	instigator,
		string	transformId,
		Vector3	positionOne,
		Vector3	positionTwo,
		float	duration )

Change a visual transform's rotation over time between two pre-determined positions.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
positionOne	The local rotation to start from.
positionTwo	The local rotation to move to.
duration	The duration of this movement.

SetLocalRotationFromTo() [2/2]

void SetLocalRotationFromTo	(	Context	instigator,
		string	transformId,
		Vector3	positionOne,
		Vector3	positionTwo,
		float	duration,
		string	callbackName )

Change a visual transform's rotation over time between two pre-determined positions, event fires on the rotation finishing.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)
positionOne	The local rotation to start from.
positionTwo	The local rotation to move to.
duration	The duration of this movement.
callbackName	Lua function name to call when rotation has finished.

StopContinousRotation()

void StopContinousRotation	(	Context	instigator,
		string	transformId )

Stop a visual transform's continus rotation.

Parameters

instigator	The source context of this change.
transformId	Transform ID. (Example: Transforms.Base)