Class Objective

Namespace

Exiled.API.Features.Objectives

Assembly

Exiled.API.dll

A wrapper for Faction objective.

public class Objective : TypeCastObject<FactionObjectiveBase>, IWrapper<FactionObjectiveBase>

Inheritance

object

TypeCastObject<FactionObjectiveBase>

Objective

Implements

IWrapper<FactionObjectiveBase>

Derived

HumanObjective<T>

Inherited Members

TypeCastObject<FactionObjectiveBase>.Cast<TObject>()

TypeCastObject<FactionObjectiveBase>.Cast<TObject>(out TObject)

TypeCastObject<FactionObjectiveBase>.As<TObject>()

TypeCastObject<FactionObjectiveBase>.Is<TObject>(out TObject)

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 Respawning.Objectives.FactionObjectiveBase that this class is wrapping.

public FactionObjectiveBase Base { get; }

Property Value

FactionObjectiveBase

List

Gets all objectives.

public static IReadOnlyCollection<Objective> List { get; }

Property Value

IReadOnlyCollection<Objective>

Type

Gets the type of objective.

public virtual ObjectiveType Type { get; }

Property Value

ObjectiveType

Methods

Achieve()

Achieves objective.

public void Achieve()

Get(ObjectiveType)

Gets the objective by its type.

public static Objective Get(ObjectiveType type)

Parameters

type ObjectiveType

Type of objective.

Returns

Objective

An Objective instance if found, null otherwise.

Get(FactionObjectiveBase)

Gets the objective by its base.

public static Objective Get(FactionObjectiveBase factionObjectiveBase)

Parameters

factionObjectiveBase FactionObjectiveBase

A Respawning.Objectives.FactionObjectiveBase instance.

Returns

Objective

An Objective instance.

GrantInfluence(Faction, float)

Grants influence to faction.

public void GrantInfluence(Faction faction, float amount)

Parameters

faction Faction

Faction to affect.

amount float

Amount of influence to grant.

IsValidFaction(Player)

Checks if player has this objective.

public bool IsValidFaction(Player player)

Parameters

player Player

Player to check.

Returns

bool

true if player has this objective, false otherwise.

IsValidFaction(Faction)

Checks if faction has this objective.

public bool IsValidFaction(Faction faction)

Parameters

faction Faction

Faction to check.

Returns

bool

true if faction has this objective, false otherwise.

ReduceTimer(Faction, float)

Reduces timer for faction.

public void ReduceTimer(Faction faction, float seconds)

Parameters

faction Faction

Faction to affect.

seconds float

Time to reduce in seconds.