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.
Waypoint Class

Search our Site


The Waypoint class allows you to access a waypoint object within your zone from its object ID. All settings can be manipulated through script

Constructors
new(int ObjectID) Description
Gets a waypoint object in the current zone from its object ID.

Parameters
int ObjectID
  • The object ID of the waypoint you want to access in the script.
  • This can be found in the World Editor under the Object General Properties Tab.

Returns
Waypoint


Functions
AppendPath(Path path) Description
Appends a path to the waypoint.

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

Returns
Void
GetPath(int index) Description
Returns the path at the specified index from the waypoint.

Parameters
int index
  • The index of the path to return.

Returns
Path
RemovePath(int index) Description
Removes a path from the waypoint at the specified index.

Parameters
int index
  • The index of the path that is to be removed.

Returns
Void


Properties
Vector3D position Gets or sets the Position of the Waypoint.
float positionX Gets or sets the X Position of the Waypoint.
float positionY Gets or sets the Y Position of the Waypoint.
float positionZ Gets or sets the Z Position of the Waypoint.
Vector3D rotation Gets or sets the Rotation of the Waypoint.
float rotationX Gets or sets the X Position of the Waypoint.
float rotationY Gets or sets the Y Position of the Waypoint.
float rotationZ Gets or sets the Z Position of the Waypoint.
float sleepRandomiser Gets or sets the sleep randomiser of the Waypoint.
float sleepTimer Gets or sets the sleep timer of the Waypoint.