public class TransformWrapper : ComponentWrapper

The entity's transform. Contains things like its position, rotation, scale, etc.

public LuaVector3 GetPosition()

(Client) Get the position of this transform.

Returns: (Vector3) The position vector.

public LuaQuaternion GetRotation()

(Client) Get the rotation of this transform.

Returns: (Quaternion) The rotation quaternion

public LuaVector3 GetEulers()

(Client) Get the rotation of this transform in euler angles.

Returns: (Vector3) The euler angles vector.

public LuaVector3 GetScale()

(Client) Get the scale of this transform.

Returns: (Vector3) The scale of this transform.

public void SetPosition(LuaVector3 vector)

(Client) Set the position of this transform.

Arguments

• (Vector3) The position vector. [vector]

public void SetRotation(LuaQuaternion quat)

(Client) Set the rotation of this transform.

Arguments

• (Quaternion) The rotation quaternion [quat]

public void SetEulers(LuaVector3 vector)

(Client) Set the rotation of this transform in euler angles.

Arguments

• (Vector3) The euler angles vector. [vector]

public void SetScale(LuaVector3 scale)

(Client) Set the scale of this transform.

Arguments

• (Vector3) The scale vector. [scale]

public void TweenPosition(LuaVector3 vector, float duration, int easing = 1)

(Client) Moves this transform to provided position in set duration.

Arguments

• (Vector3) Target position. [vector]

• (float) Time to reach target position. [duration]

• (int) Easing type index. Defaults to Linear. [easing]

public void TweenRotation(LuaQuaternion quat, float duration, int easing = 1)

(Client) Rotates this transform to provided rotation in set duration.

Arguments

• (Quaternion) Target rotation. [quat]

• (float) Time to reach target rotation. [duration]

• (int) Easing type index. Defaults to Linear. [easing]

public void TweenEulers(LuaVector3 vector, float duration, int easing = 1)

(Client) Rotates this transform to provided euler facing in set duration.

Arguments

• (Vector3) Target rotation. [vector]

• (float) Time to reach target rotation. [duration]

• (int) Easing type index. Defaults to Linear. [easing]

public void TweenScale(LuaVector3 vector, float duration, int easing = 1)

(Client) Scales this transform to provided scale in set duration.

Arguments

• (Vector3) Target scale. [vector]

• (float) Time to reach target scale. [duration]

• (int) Easing type index. Defaults to Linear. [easing]

public void CancelTween(bool complete)

(Client) Stops this transform's current tween.

Arguments

• (bool) Should the tween be completed? [complete]

public void ShakePosition(float duration, LuaVector3 strength, int vibrato = 10)

(Client) Shakes this transform's position.

Arguments

• (float) Shaking duration. [duration]

• (Vector3) Shaking strength. [strength]

• (int) Shaking vibration. [vibrato]

public void ShakeRotation(float duration, LuaVector3 strength, int vibrato = 10)

(Client) Shakes this transform's rotation.

Arguments

• (float) Shaking duration. [duration]

• (Vector3) Shaking strength (in eulers). [strength]

• (int) Shaking vibration. [vibrato]

public void ShakeScale(float duration, LuaVector3 strength, int vibrato = 10)

(Client) Shakes this transform's scale.

Arguments

• (float) Shaking duration. [duration]

• (Vector3) Shaking strength. [strength]

• (int) Shaking vibration. [vibrato]

public void SetForward(LuaVector3 vector)

(Client) Set the forward direction vector of this transform.

Arguments

• (Vector3) The forward direction vector. [vector]

public void SetRight(LuaVector3 vector)

(Client) Set the right direction vector of this transform.

Arguments

• (Vector3) The right direction vector. [vector]

public void SetUp(LuaVector3 vector)

(Client) Set the up direction vector of this transform.

Arguments

• (Vector3) The up direction vector. [vector]

public LuaVector3 GetForward()

(Client) Get the forward direction vector of this transform.

Returns: (Vector3) The forward direction vector.

public LuaVector3 GetRight()

(Client) Get the right direction vector of this transform.

Returns: (Vector3) The right direction vector.

public LuaVector3 GetUp()

(Client) Get the up direction vector of this transform.

Returns: (Vector3) The up direction vector.

public TransformWrapper GetParent()

(Client) Gets the parent of this transform.

Returns: (Transform) The parent of this transform.

public void SetParent(TransformWrapper transform)

(Client) Set the parent of this transform.

Arguments

• (Transform) The new parent of this transform. [transform]

public int GetSiblingIndex()

(Client) Gets the sibling index of this transform.

Returns: (int) The sibling index of this transform.

public void SetSiblingIndex(int index)

(Client) Sets the sibling index of this transform.

Arguments

• (int) The sibling index of this transform. [index]

public TransformWrapper GetChild(int index)

(Client) Gets a child of this transform by index.

Arguments

• (int) The index of the child to get. [index]

Returns: (Transform) The child of this transform that answers to index.

public int GetChildCount()

(Client) Gets the amount of children this transform has.

Returns: (int) The amount of children this transform has.

public void LookAt(LuaVector3 target)

(Client) Makes this transform look at a world position target.

Arguments

• (Vector3) The world position of the target. [target]

public void LookAtTransform(TransformWrapper transform)

(Client) Makes this transform look at a different transform.

Arguments

• (Transform) The other transform to look at. [transform]

public void RotateRelative(LuaVector3 axis, float angle)

(Client) Rotates this transform by an angle around some axis relative to itself.

Arguments

• (Vector3) The axis. [axis]

• (float) The angle. [angle]

public void RotateAbsolute(LuaVector3 axis, float angle)

(Client) Rotates this transform by an angle around some axis relative to the world.

Arguments

• (Vector3) The axis. [axis]

• (float) The angle. [angle]

public void RotateEulersRelative(LuaVector3 eulers)

(Client) Applies a rotation of eulerAngles.z degrees around the z-axis, eulerAngles.x degrees around the x-axis, and eulerAngles.y degrees around the y-axis (in that order) relative to itself.

Arguments

• (Vector3) The euler angles. [eulers]

public void RotateEulersAbsolute(LuaVector3 eulers)

(Client) Applies a rotation of eulerAngles.z degrees around the z-axis, eulerAngles.x degrees around the x-axis, and eulerAngles.y degrees around the y-axis (in that order) relative to the world.

Arguments

• (Vector3) The euler angles. [eulers]