Class AEffect

Namespace

AO

Assembly

CoreAssembly.dll

Base class for effects that can be added to players.

public abstract class AEffect : Component, INetworkedComponent

Inheritance

object

Component

AEffect

Implements

INetworkedComponent

Derived

EmoteEffect

Inherited Members

Component.Entity

Component.LocalEnabled

Component.WorldEnabled

Component.Position

Component.AddComponent<T>()

Component.GetComponent<T>()

Component.Awaken()

Component.Awake()

Component.PredictUpdate(uint)

Component.PredictLateUpdate(uint)

Component.OnDestroy()

Component.ToString()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

ComponentExtensions.Alive(Component)

JSONWriter.ToJson(object)

Fields

Ability

The ability responsible for the effect

public Ability Ability

Field Value

Ability

AbilityDirection

public Vector2 AbilityDirection

Field Value

Vector2

AbilityIndex

public int AbilityIndex

Field Value

int

AbilityMagnitude

public float AbilityMagnitude

Field Value

float

Caster

The player who cast this effect, if any.

public Player Caster

Field Value

Player

DurationProgress01

The percentage progress of the effect's duration, from 0 to 1.

public float DurationProgress01

Field Value

float

DurationRemaining

The remaining duration of the effect, in seconds.

public float DurationRemaining

Field Value

float

ElapsedTime

How long this effect has been running.

public float ElapsedTime

Field Value

float

InitialDuration

The initial duration of the effect, in seconds.

public float InitialDuration

Field Value

float

Player

The player who has this effect.

public Player Player

Field Value

Player

Properties

AbilityWhitelist

Whitelist of ability types that can still be used if BlockAbilityActivation is true

public virtual List<Type> AbilityWhitelist { get; }

Property Value

List<Type>

BlockAbilityActivation

If true, the player will not be able to use abilities while this effect is active. Default to IsActiveEffect.

public virtual bool BlockAbilityActivation { get; }

Property Value

bool

BlockInteractables

If true, the player will not be able to use interactables while this effect is active. Default to BlockAbilityActivation.

public virtual bool BlockInteractables { get; }

Property Value

bool

DefaultDuration

The default duration of the effect, in seconds. Do not override if the effect is permanent, or you plan to set the duration when calling AddEffect.

public virtual float DefaultDuration { get; }

Property Value

float

DisableMovementInput

If true, movement inputs will be ignored for this player.

public virtual bool DisableMovementInput { get; }

Property Value

bool

FreezePlayer

If true, the player will be frozen while this effect is active.

public virtual bool FreezePlayer { get; }

Property Value

bool

GetInterruptedByNewActiveEffects

If true, this effect will be removed with interrupt when a new active effect is added. Useful for UI effects like opening up a map where you want to be able to do it even if you currently have an Active effect, but want to be taken out of it if somebody attacks you while its open for example.

public virtual bool GetInterruptedByNewActiveEffects { get; }

Property Value

bool

Invisibility

If true, the player will be invisible while this effect is active.

public virtual bool Invisibility { get; }

Property Value

bool

IsActiveEffect

Only one active effect may be on a player at a time. If true, this effect will cancel the existing active effect when added to a player.

public abstract bool IsActiveEffect { get; }

Property Value

bool

IsValidTarget

If true, the player will be a valid target for other player abilities while this effect is active.

public virtual bool IsValidTarget { get; }

Property Value

bool

NameInvisibility

If true, the player's will be invisible while this effect is active.

public virtual bool NameInvisibility { get; }

Property Value

bool

Methods

AEffectNetworkDeserialize(StreamReader)

public void AEffectNetworkDeserialize(StreamReader reader)

Parameters

reader StreamReader

AEffectNetworkSerialize(StreamWriter)

public void AEffectNetworkSerialize(StreamWriter writer)

Parameters

writer StreamWriter

LateUpdate()

Called every frame the entity is enabled, after all Update methods have been called.

public override sealed void LateUpdate()

NetworkDeserialize(StreamReader)

Called on a new player when they drop in. Receives the data written by NetworkSerialize.

public virtual void NetworkDeserialize(StreamReader reader)

Parameters

reader StreamReader

NetworkSerialize(StreamWriter)

Called on the server when a new player drops in. Serialize any data you want the client to receive.

public virtual void NetworkSerialize(StreamWriter writer)

Parameters

writer StreamWriter

OnAnimationEvent(string)

Animation events from the player will be forwarded to this method.

public virtual void OnAnimationEvent(string eventName)

Parameters

eventName string

OnEffectEnd(bool)

Called when the effect's duration ends, or when it is removed from the player.

public virtual void OnEffectEnd(bool interrupt)

Parameters

interrupt bool

True if the effect was removed before its duration ended.

Remarks

Interrupt being true is often a signal that something different needs to happen in the end. For example, perhaps you have an effect to open a chest that the player can loot. If interrupt is true you probably would not want to grant the loot to the player.

OnEffectLateUpdate()

Called once per frame while the effect is alive.

public virtual void OnEffectLateUpdate()

OnEffectStart(bool)

Called when the effect is added to a player. When a new player joins an already-running game, all existing effects are automatically created for all players and OnEffectStart() is called with isDropIn == true.

public virtual void OnEffectStart(bool isDropIn)

Parameters

isDropIn bool

OnEffectUpdate()

Called once per frame while the effect is alive.

public virtual void OnEffectUpdate()

Update()

Called every frame the entity is enabled.

public override sealed void Update()