Class LockerSpawnPoint

Namespace

Exiled.API.Features.Spawn

Assembly

Exiled.API.dll

Handles the spawn point inside a locker.

public class LockerSpawnPoint : SpawnPoint, IPosition

Inheritance

object

SpawnPoint

LockerSpawnPoint

Implements

IPosition

Inherited Members

SpawnPoint.Deconstruct(out float, out Vector3)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Properties

Chance

Gets or sets the spawn chance.

public override float Chance { get; set; }

Property Value

float

Name

Gets or sets this spawn point name.

[YamlIgnore]
public override string Name { get; set; }

Property Value

string

Offset

Gets or sets the offset position within the locker where the spawn point is located, relative to the locker's origin.

public Vector3 Offset { get; set; }

Property Value

Vector3

Position

Gets or sets this spawn point position.

[YamlIgnore]
public override Vector3 Position { get; set; }

Property Value

Vector3

Type

Gets or sets the type of the Locker.

public LockerType Type { get; set; }

Property Value

LockerType

UseChamber

Gets or sets a value indicating whether to use a random locker chamber's position for spawning. If true, Offset will be ignored.

public bool UseChamber { get; set; }

Property Value

bool

Zone

Gets or sets the zone where the locker is located.

public ZoneType Zone { get; set; }

Property Value

ZoneType

Methods

GetSpawningInfo(out Locker, out Chamber, out Vector3)

Gets the spawn info.

public void GetSpawningInfo(out Locker locker, out Chamber chamber, out Vector3 position)

Parameters

locker Locker

The locker to spawn in.

chamber Chamber

The chamber to spawn in. Null when UseChamber is false.

position Vector3

The position to spawn in.

Exceptions

NullReferenceException

No locker was found.