PlugVector3Path Class Reference

Plugin for the tweening of Vector3 objects along a Vector3 path. More...

Inheritance diagram for PlugVector3Path:

List of all members.

Public Member Functions
	PlugVector3Path (Vector3[] p_path, PathType p_type=PathType.Curved)
	Creates a new instance of this plugin using the main ease type and an absolute path.
	PlugVector3Path (Vector3[] p_path, EaseType p_easeType, PathType p_type=PathType.Curved)
	Creates a new instance of this plugin using an absolute path.
	PlugVector3Path (Vector3[] p_path, bool p_isRelative, PathType p_type=PathType.Curved)
	Creates a new instance of this plugin using the main ease type.
	PlugVector3Path (Vector3[] p_path, EaseType p_easeType, bool p_isRelative, PathType p_type=PathType.Curved)
	Creates a new instance of this plugin.
	PlugVector3Path (Vector3[] p_path, AnimationCurve p_easeAnimCurve, bool p_isRelative, PathType p_type=PathType.Curved)
	Creates a new instance of this plugin.
PlugVector3Path	ClosePath ()
	Parameter > Smoothly closes the path, so that it can be used for cycling loops.
PlugVector3Path	ClosePath (bool p_close)
	Parameter > Choose whether to smoothly close the path, so that it can be used for cycling loops.
PlugVector3Path	OrientToPath ()
	Parameter > If the tween target is a Transform, orients the tween target to the path.
PlugVector3Path	OrientToPath (bool p_orient)
	Parameter > Choose whether to orient the tween target to the path (only if it's a Transform).
PlugVector3Path	OrientToPath (float p_lookAhead)
	Parameter > If the tween target is a Transform, orients the tween target to the path, using the given lookAhead percentage.
PlugVector3Path	OrientToPath (Axis p_lockRotationAxis)
	Parameter > If the tween target is a Transform, orients the tween target to the path, locking its rotation on the given axis.
PlugVector3Path	OrientToPath (float p_lookAhead, Axis p_lockRotationAxis)
	Parameter > If the tween target is a Transform, orients the tween target to the path, using the given lookAhead percentage and locking its rotation on the given axis.
PlugVector3Path	OrientToPath (bool p_orient, float p_lookAhead, Axis p_lockRotationAxis)
	Parameter > Choose whether to orient the tween target to the path (only if it's a Transform), and which lookAhead percentage ad lockRotation to use.
PlugVector3Path	LookAt (Transform p_transform)
	Parameter > If the tween target is a Transform, sets the tween so that the target will always look at the given transform.
PlugVector3Path	LookAt (Vector3 p_position)
	Parameter > If the tween target is a Transform, sets the tween so that the target will always look at the given position.
PlugVector3Path	LockPosition (Axis p_lockAxis)
	Parameter > locks the given position axis.

---

Detailed Description

Plugin for the tweening of Vector3 objects along a Vector3 path.

---

Constructor & Destructor Documentation

PlugVector3Path	(	Vector3[]	p_path,
		PathType	p_type = PathType.Curved
	)

Creates a new instance of this plugin using the main ease type and an absolute path.

Parameters:

p_path	The Vector3 path to tween through.
p_type	Type of path

PlugVector3Path	(	Vector3[]	p_path,
		EaseType	p_easeType,
		PathType	p_type = PathType.Curved
	)

Creates a new instance of this plugin using an absolute path.

Parameters:

p_path	The Vector3 path to tween through.
p_easeType	The EaseType to use.
p_type	Type of path

PlugVector3Path	(	Vector3[]	p_path,
		bool	p_isRelative,
		PathType	p_type = PathType.Curved
	)

Creates a new instance of this plugin using the main ease type.

Parameters:

p_path	The Vector3 path to tween through.
p_isRelative	If true, the path is considered relative to the starting value of the property, instead than absolute. Not compatible with HOTween.From.
p_type	Type of path

PlugVector3Path	(	Vector3[]	p_path,
		EaseType	p_easeType,
		bool	p_isRelative,
		PathType	p_type = PathType.Curved
	)

Creates a new instance of this plugin.

Parameters:

p_path	The Vector3 path to tween through.
p_easeType	The EaseType to use.
p_isRelative	If true, the path is considered relative to the starting value of the property, instead than absolute. Not compatible with HOTween.From.
p_type	Type of path

PlugVector3Path	(	Vector3[]	p_path,
		AnimationCurve	p_easeAnimCurve,
		bool	p_isRelative,
		PathType	p_type = PathType.Curved
	)

Creates a new instance of this plugin.

Parameters:

p_path	The Vector3 path to tween through.
p_easeAnimCurve	The AnimationCurve to use for easing.
p_isRelative	If true, the given end value is considered relative instead than absolute.
p_type	Type of path

---

Member Function Documentation

PlugVector3Path ClosePath

(

)

Parameter > Smoothly closes the path, so that it can be used for cycling loops.

Returns:

A PlugVector3Path

PlugVector3Path ClosePath

(

bool

p_close

)

Parameter > Choose whether to smoothly close the path, so that it can be used for cycling loops.

Parameters:

p_close

Set to true to close the path.

PlugVector3Path LockPosition

(

Axis

p_lockAxis

)

Parameter > locks the given position axis.

Parameters:

p_lockAxis

Sets one or more axis to lock. To lock more than one axis, use the bitwise OR operator (ex: Axis.X | Axis.Y)

Returns:

PlugVector3Path LookAt

(

Transform

p_transform

)

Parameter > If the tween target is a Transform, sets the tween so that the target will always look at the given transform.

Parameters:

p_transform

The Transform to look at.

PlugVector3Path LookAt

(

Vector3

p_position

)

Parameter > If the tween target is a Transform, sets the tween so that the target will always look at the given position.

Parameters:

p_position

The Vector3 to look at.

PlugVector3Path OrientToPath

(

)

Parameter > If the tween target is a Transform, orients the tween target to the path.

Returns:

A PlugVector3Path

PlugVector3Path OrientToPath

(

bool

p_orient

)

Parameter > Choose whether to orient the tween target to the path (only if it's a Transform).

Parameters:

p_orient

Set to true to orient the tween target to the path.

PlugVector3Path OrientToPath

(

float

p_lookAhead

)

Parameter > If the tween target is a Transform, orients the tween target to the path, using the given lookAhead percentage.

Parameters:

p_lookAhead

The look ahead percentage (0 to 1).

PlugVector3Path OrientToPath

(

Axis

p_lockRotationAxis

)

Parameter > If the tween target is a Transform, orients the tween target to the path, locking its rotation on the given axis.

Parameters:

p_lockRotationAxis

Sets one or more axis to lock while rotating. To lock more than one axis, use the bitwise OR operator (ex: Axis.X | Axis.Y).

PlugVector3Path OrientToPath	(	float	p_lookAhead,
		Axis	p_lockRotationAxis
	)

Parameter > If the tween target is a Transform, orients the tween target to the path, using the given lookAhead percentage and locking its rotation on the given axis.

Parameters:

p_lookAhead	The look ahead percentage (0 to 1)
p_lockRotationAxis	Sets one or more axis to lock while rotating. To lock more than one axis, use the bitwise OR operator (ex: Axis.X | Axis.Y).

PlugVector3Path OrientToPath	(	bool	p_orient,
		float	p_lookAhead,
		Axis	p_lockRotationAxis
	)

Parameter > Choose whether to orient the tween target to the path (only if it's a Transform), and which lookAhead percentage ad lockRotation to use.

Parameters:

p_orient	Set to true to orient the tween target to the path.
p_lookAhead	The look ahead percentage (0 to 1).
p_lockRotationAxis	Sets one or more axis to lock while rotating. To lock more than one axis, use the bitwise OR operator (ex: Axis.X | Axis.Y).