PostEffectData

ReferencesSince v8.0
This is a wrapper around the data ('on', 'shown', 'state' parameters, etc.) of a post effect.

Finalizer

~PostEffectData

#
~PostEffectData()

Properties

Collection

#Since v8.0
public PostEffectCollection Collection { get; }

Id

#Since v8.0
Returns the unique id of this post effect.
public Guid Id { get; }

LocalName

#Since v8.0
Returns the localized name of this post effect.
public string LocalName { get; }

On

#Since v8.0
The 'on' state of this post effect.
public bool On { get; set; }

Shown

#Since v8.0
The 'shown' state of this post effect.
public bool Shown { get; set; }

Type

#Since v8.0
Returns the type of this post effect.
public PostEffectType Type { get; }

Methods

DataCRC

#Since v8.0
Get a CRC representing the state of the entire post effect.
[CLSCompliant(false)] public uint DataCRC(
current_remainder
)

Dispose

#Since v8.0
public void Dispose()

Dispose

#
protected virtual void Dispose(
disposing
)

GetParameter

#Since v8.0
Get an arbitrary parameter from this post effect by its name. If the parameter is not known to the post effect, the method will fail. Returns a variant object if successful or null on failure.
[CLSCompliant(false)] public IConvertible GetParameter(
param_name
)

SetParameter

#Since v8.0
Set an arbitrary parameter to the post effect by its name. If the parameter is not known to the post effect, the method will fail. Returns true if successful or false on failure.
public bool SetParameter(
param_name,
param_value
)