• Public
  • Public/Protected
  • All

A behavior that forwards the EffectBehavior interface to its object.





  • activate(enable: boolean): void
  • activated(): boolean
  • enableEffect(name: string, enable: boolean): void
  • getName(): string
  • getNameId(): number
  • isEffectEnabled(name: string): boolean
  • onActivate(): void
  • onCreated(): void
  • onDeActivate(): void
  • onDestroy(): void
  • This method is called when the owner of the behavior is being removed from the scene and is about to be destroyed/reused later or when the behavior is removed from an object (can happen in case of hot-reloading only. Otherwise, behaviors are just de-activated, not removed. See onDeActivate).

    Returns void

  • onObjectHotReloaded(): void
  • setEffectBooleanParameter(name: string, parameterName: string, value: boolean): boolean
  • setEffectDoubleParameter(name: string, parameterName: string, value: number): boolean
  • setEffectStringParameter(name: string, parameterName: string, value: string): boolean
  • updateFromBehaviorData(oldBehaviorData: any, newBehaviorData: any): boolean
  • usesLifecycleFunction(): boolean
  • Should return false if the behavior does not need any lifecycle function to be called. Default, hidden, "capability" behaviors set it to false. This avoids useless calls to empty lifecycle functions, which would waste CPU time (and have a sizeable impact for example when lots of static instances are living in the scene).

    Returns boolean



name: string
type: string

Generated using TypeDoc