Interface EffectHandler

Hierarchy

EffectHandler

Implemented by

Index

Methods

Methods

enableEffect

enableEffect(name: string, enable: boolean): void

- Defined in GDJS/Runtime/object-capabilities/EffectBehavior.ts:49
Enable or disable an effect.

Parameters
- name: string
  
  The name of the effect to enable or disable.
- enable: boolean
  
  true to enable, false to disable
Returns void

isEffectEnabled

isEffectEnabled(name: string): boolean

- Defined in GDJS/Runtime/object-capabilities/EffectBehavior.ts:56
Check if an effect is enabled

Parameters
- name: string
  
  The name of the effect
Returns boolean
true if the effect is enabled, false otherwise.

setEffectBooleanParameter

setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean

- Defined in GDJS/Runtime/object-capabilities/EffectBehavior.ts:38
Change an effect property value (for properties that are booleans).

Parameters
- name: string
  
  The name of the effect to update.
- parameterName: string
  
  The name of the property to update.
- value: boolean
  
  The new value (boolean).
Returns boolean

setEffectDoubleParameter

setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean

- Defined in GDJS/Runtime/object-capabilities/EffectBehavior.ts:14
Change an effect property value (for properties that are numbers).

Parameters
- name: string
  
  The name of the effect to update.
- parameterName: string
  
  The name of the property to update.
- value: number
  
  The new value (number).
Returns boolean

setEffectStringParameter

setEffectStringParameter(name: string, parameterName: string, value: string): boolean

- Defined in GDJS/Runtime/object-capabilities/EffectBehavior.ts:26
Change an effect property value (for properties that are strings).

Parameters
- name: string
  
  The name of the effect to update.
- parameterName: string
  
  The name of the property to update.
- value: string
  
  The new value (string).
Returns boolean

Generated using TypeDoc