PostEffectData

ReferencesSince v8.0
public class PostEffectData : IDisposable
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
public Guid Id { get; }
Returns the unique id of this post effect.

LocalName

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

On

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

Shown

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

Type

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

Methods

DataCRC

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

Dispose

#Since v8.0
public void Dispose()

Dispose

#
protected virtual void Dispose(bool disposing)
Parameters:
disposing (bool)

GetParameter

#Since v8.0
[CLSCompliant(false)] public IConvertible GetParameter(string param_name)
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.
Parameters:
param_name (string)

SetParameter

#Since v8.0
public bool SetParameter(string param_name, object param_value)
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.
Parameters:
param_name (string)
param_value (object)