Class ParticleEffectParameter

Particle system parameter.

Inheritance

Object

ScriptingObject

ParticleEffectParameter

Inherited Members

ScriptingObject::_gcHandle

ScriptingObject::_id

ScriptingObject::_type

ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)

ScriptingObject::CanCast(const MClass* from, const MClass* to)

ScriptingObject::Cast(ScriptingObject* obj)

ScriptingObject::ChangeID(const Guid& newId)

ScriptingObject::CreateManaged()

ScriptingObject::CreateManagedInternal()

ScriptingObject::Deleted

Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)

Object::DeleteObjectNow()

ScriptingObject::DestroyManaged()

Object::Flags

ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::FromInterface(T* interfaceObj)

ScriptingObject::GetClass()

ScriptingObject::GetID()

ScriptingObject::GetManagedInstance()

ScriptingObject::GetOrCreateManagedInstance()

ScriptingObject::GetType()

ScriptingObject::GetTypeHandle()

ScriptingObject::HasManagedInstance()

ScriptingObject::Is(const ScriptingTypeHandle& type)

ScriptingObject::Is(const MClass* type)

ScriptingObject::Is()

ScriptingObject::IsRegistered()

ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)

ScriptingObject::NewObject()

ScriptingObject::OnDeleteObject()

ScriptingObject::OnManagedInstanceDeleted()

ScriptingObject::OnScriptingDispose()

ScriptingObject::RegisterObject()

ScriptingObject::ScriptingObject(const SpawnParams& params)

ScriptingObject::SetManagedInstance(MObject* instance)

ParticleEffectParameter

ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)

ScriptingObject::ToInterface(ScriptingObject* obj)

ScriptingObject::ToManaged(const ScriptingObject* obj)

ScriptingObject::ToNative(MObject* obj)

ScriptingObject::ToString()

ScriptingObject::UnregisterObject()

Object::~Object()

ScriptingObject::~ScriptingObject()

Assembly: FlaxEngine.dll

File: Engine/Particles/ParticleEffect.h

Syntax

public class ParticleEffectParameter : public ScriptingObject

Constructors

ParticleEffectParameter()

Initializes a new instance of the ParticleEffectParameter class.

Declaration

public ParticleEffectParameter()

Methods

GetDefaultEmitterValue()

Gets the default value of the parameter (set in particle emitter asset).

Declaration

public Variant GetDefaultEmitterValue() const

Returns

Variant The default value.

GetDefaultValue()

Gets the default value of the parameter (set in particle system asset).

Declaration

public Variant GetDefaultValue() const

Returns

Variant The default value.

GetEmitter()

Gets the emitter that this parameter belongs to.

Declaration

public ParticleEmitter* GetEmitter() const

Returns

ParticleEmitter

GetEmitterIndex()

Gets the index of the emitter (not the emitter track but the emitter).

Declaration

public int32 GetEmitterIndex() const

Returns

int32

GetEmitterParameter()

Gets the particle emitter parameter from the asset (the parameter instanced by this object).

Declaration

public GraphParameter* GetEmitterParameter() const

Returns

GraphParameter The particle emitter parameter overriden by this object.

GetIsPublic()

Gets the parameter flag that indicates whenever it's exposed to public.

Declaration

public bool GetIsPublic() const

Returns

bool

GetName()

Gets the parameter name.

Declaration

public String GetName() const

Returns

String

GetParamIdentifier()

Gets the parameter unique ID.

Declaration

public Guid GetParamIdentifier() const

Returns

Guid

GetParamIndex()

Gets the parameter index (in the emitter parameters list).

Declaration

public int32 GetParamIndex() const

Returns

int32

GetParamType()

Gets the parameter type.

Declaration

public VariantType GetParamType() const

Returns

VariantType

GetTrackName()

Gets the emitter track name.

Declaration

public String GetTrackName() const

Returns

String

GetValue()

Gets the value of the parameter.

Declaration

public Variant GetValue() const

Returns

Variant The value.

IsValid()

Returns true if parameter object handle is valid.

Declaration

public bool IsValid() const

Returns

bool

SetValue(const Variant& value)

Sets the value of the parameter.

Declaration

public void SetValue(const Variant& value) const

Parameters

Variant value The value.