Class ZoneRegion

Namespace

Uncreated.Warfare.Zones

Assembly

Uncreated.Warfare.dll

Represents a zone or cluster of zones linked with their IProximity instances.

public class ZoneRegion : IDisposable

Inheritance

object

ZoneRegion

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Properties

Count

Total number of zones in this cluster.

public int Count { get; }

Property Value

int

Data

Abstract data linked to a zone.

public ZoneRegionData Data { get; }

Property Value

ZoneRegionData

Name

The shared name of the cluster of zones.

public string Name { get; }

Property Value

string

Players

List of all players currently inside the zone.

public ReadOnlyTrackingList<WarfarePlayer> Players { get; }

Property Value

ReadOnlyTrackingList<WarfarePlayer>

Primary

The zone marked as primary of this group.

[JsonIgnore]
public ref readonly ZoneProximity Primary { get; }

Property Value

ZoneProximity

PrimaryIndex

The index of the primary zone in Zones.

public int PrimaryIndex { get; }

Property Value

int

ShortName

The shared short name of the cluster of zones.

public string? ShortName { get; }

Property Value

string

TeamCounts

Keeps track of how many players are on the flag for each team.

public TeamCountTable TeamCounts { get; }

Property Value

TeamCountTable

Zones

List of all zones in this cluster.

public IReadOnlyList<ZoneProximity> Zones { get; }

Property Value

IReadOnlyList<ZoneProximity>

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

TestPoint(Vector2)

Check if a position is within the proximity while ignoring Y position.

public bool TestPoint(Vector2 position)

Parameters

position Vector2

Returns

bool

TestPoint(Vector3)

Check if a position is within the proximity.

public bool TestPoint(Vector3 position)

Parameters

position Vector3

Returns

bool

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Events

OnPlayerEntered

Invoked when a player goes in proximity of any zone in the cluster.

public event Action<ZoneRegion, WarfarePlayer>? OnPlayerEntered

Event Type

Action<ZoneRegion, WarfarePlayer>

OnPlayerExited

Invoked when a player leaves proximity of any zone in the cluster.

public event Action<ZoneRegion, WarfarePlayer>? OnPlayerExited

Event Type

Action<ZoneRegion, WarfarePlayer>