Sample Sidebar Module

This is a sample module published to the sidebar_top position, using the -sidebar module class suffix. There is also a sidebar_bottom position below the menu.
Register

Sample Sidebar Module

This is a sample module published to the sidebar_bottom position, using the -sidebar module class suffix. There is also a sidebar_top position below the search.
Path Class

Search our Site


The Path class allows you to edit or create a new path assigned to a waypoint object within your zone. All settings can be manipulated through script.

Constructors
new(string name) Description
Creates a new unassigned path.

Parameters
string name
  • Name of the new path.

Returns
Path


Functions
AppendToPath(Waypoint waypoint) Description
Appends the specified waypoint to the end of the path. Returns true if this operation was successful.

Parameters
Waypoint waypoint
  • The waypoint to be appended to the path.

Returns
Void
FlipDirection() Description
Reverses the order of waypoint within the path to reverse the direction.

Parameters
None

Returns
Void
GetPathCurveOffset(int index) Description
Returns the curve offset of node at the specified index of the path.

Parameters
int index
  • The index of the node within the path.

Returns
Vector3D
GetPathWaypoint(int index) Description
Returns the Waypoint at the specified index within the path.

Parameters
int index
  • The index of the waypoint within the path.

Returns
Waypoint
RemoveFromPath(int index) Description
The index of the waypoint within the path.

Parameters
int index
  • The index of the waypoint within the path.

Returns
Void
SetPathCurveOffset(int index, Vector3D offset) Description
Moves the camera Up from the direction it is currently facing.

Parameters
int index
  • The index of the waypoint within the path.
Vector3D offset
  • The offset to be applied.

Returns
Void


Properties
Vector3D color Gets or sets the color of the path.
int lerpType Gets or sets the interpolation type of the path.
  • 0 : Linear
  • 1 : Bezier
int loopType Gets or sets the loop type of the path.
  • 0 : Loop
  • 1 : Ping-Pong
  • 2 : Once
string name Gets or sets the name of the path.
float overrideSpeed Gets or sets the override speed of the path.
int speedMode Gets or sets the speed mode of the path.
  • 0 : Inherit
  • 1 : Override