Copyright © 2005-2016 MultiMedia Soft

Effects.FilterIsApplied method

Previous pageReturn to chapter overviewNext page

Remarks

 

Verifies if a filter has been applied to the given player through the Effects.FilterApply method.

 

See the How to apply special effects to a playing sound section for further details.

 

 

Syntax

 

[Visual Basic]

Public FilterIsApplied (

nPlayerIndex as integer,

ByRef bApplied as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes FilterIsApplied (

short nPlayerIndex,

ref bool bApplied

);


 

[C++]

public: enumErrorCodes FilterIsApplied (

short nPlayerIndex,

bool __gc *bApplied

);


 

 

Parameter

Description

 

 

nPlayerIndex

Number representing the zero-based index of the involved player

bApplied

Reference that, on return from the method call, will contain the boolean value specifying if the filter is currently applied.

Supported values are the following:

Mnemonic constant

Meaning

false

The filter has not been applied

true

The filter has been applied

 

 

Return value

 

Value

Meaning

 

 

false

The given effect has not been applied

true

The given effect has been applied