Class Waypoint

Namespace

Exiled.API.Features.Toys

Assembly

Exiled.API.dll

A wrapper class for AdminToys.WaypointToy.

public class Waypoint : AdminToy, IWorldSpace, IPosition, IRotation, IWrapper<WaypointToy>

Inheritance

object

AdminToy

Waypoint

Implements

IWorldSpace

IPosition

IRotation

IWrapper<WaypointToy>

Inherited Members

AdminToy.List

AdminToy.AdminToyBase

AdminToy.ToyType

AdminToy.Player

AdminToy.Footprint

AdminToy.Position

AdminToy.Rotation

AdminToy.Scale

AdminToy.GameObject

AdminToy.Transform

AdminToy.MovementSmoothing

AdminToy.IsStatic

AdminToy.Get(AdminToyBase)

AdminToy.Get<T>(AdminToyBase)

AdminToy.Spawn()

AdminToy.UnSpawn()

AdminToy.Destroy()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.ReferenceEquals(object, object)

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Base

Gets the base AdminToys.WaypointToy.

public WaypointToy Base { get; }

Property Value

WaypointToy

Bounds

Gets or sets the bounds this waypoint encapsulates.

public Bounds Bounds { get; set; }

Property Value

Bounds

BoundsSize

Gets or sets the bounds size this waypoint encapsulates.

public Vector3 BoundsSize { get; set; }

Property Value

Vector3

Prefab

Gets the prefab.

public static WaypointToy Prefab { get; }

Property Value

WaypointToy

Priority

Gets or sets the Waypoint shown.

public float Priority { get; set; }

Property Value

float

VisualizeBounds

Gets or sets a value indicating whether the Bounds are shown for Debug.

public bool VisualizeBounds { get; set; }

Property Value

bool

WaypointId

Gets the id of the Waypoint used for RelativePositioning.RelativePosition.WaypointId.

public byte WaypointId { get; }

Property Value

byte

Methods

Create(Transform, Vector3?, Quaternion?, Vector3?, float, bool, bool)

Creates a new Waypoint.

public static Waypoint Create(Transform parent = null, Vector3? position = null, Quaternion? rotation = null, Vector3? scale = null, float priority = 0, bool visualizeBounds = false, bool spawn = true)

Parameters

parent Transform

The transform to create this Waypoint on.

position Vector3?

The local position of the Waypoint.

rotation Quaternion?

The local rotation of the Waypoint.

scale Vector3?

The size of the bounds (This is NOT localScale, it applies to NetworkBoundsSize).

priority float

The priority of the waypoint.

visualizeBounds bool

Whether to visualize the bounds.

spawn bool

Whether the Waypoint should be initially spawned.

Returns

Waypoint

The new Waypoint.

Create(Transform, Vector3)

Creates a new Waypoint based on a Transform.

public static Waypoint Create(Transform transform, Vector3 size)

Parameters

transform Transform

The transform to spawn at (LocalScale is applied to Bounds).

size Vector3

The size of the bounds (Applied to NetworkBoundsSize).

Returns

Waypoint

The new Waypoint.

Create(Vector3, Vector3)

Creates a new Waypoint with a specific position and size (bounds).

public static Waypoint Create(Vector3 position, Vector3 size)

Parameters

position Vector3

The position of the Waypoint.

size Vector3

The size of the bounds (Applied to NetworkBoundsSize).

Returns

Waypoint

The new Waypoint.