IGSAPPlugin

Defined in: plugins/GSAPPlugin.ts:20

Interface for the GSAPPlugin, defining its public API for high-performance animations. Provides comprehensive GSAP integration with custom animation context management.

Extends

• IPlugin

Properties

anim

readonly anim: typeof gsap

Defined in: plugins/GSAPPlugin.ts:37

The GSAP instance for creating animations.

---

app

app: IApplication

Defined in: plugins/Plugin.ts:10

Inherited from

IPlugin.app

---

easeNames

readonly easeNames: string[]

Defined in: plugins/GSAPPlugin.ts:25

Array of all registered custom ease names.

---

eases

readonly eases: Record<string, gsap.EaseFunction>

Defined in: plugins/GSAPPlugin.ts:31

Object containing all registered custom eases, where keys are ease names and values are GSAP ease functions.

---

id

id: string

Defined in: plugins/Plugin.ts:8

Inherited from

IPlugin.id

---

options

readonly options: Partial<O>

Defined in: plugins/Plugin.ts:12

Inherited from

IPlugin.options

Methods

addAnimation()

addAnimation(animation, contextId?): Timeline | Tween | (Timeline | Tween)[]

Defined in: plugins/GSAPPlugin.ts:62

Adds one or more GSAP tweens or timelines to a specified animation context. Animation contexts are custom collections (Set) of tweens/timelines managed by this plugin, NOT gsap.Context instances. If no contextId is provided, animations are added to the global context.

Parameters

animation

A single GSAP tween/timeline or an array of them

Timeline | Tween | (Timeline | Tween)[]

contextId?

string

Optional ID of the custom animation context. Defaults to the global context

Returns

Timeline | Tween | (Timeline | Tween)[]

The animation(s) that were added

Example

// Add single animation to specific context
const tween = gsap.to(mySprite, { x: 100, duration: 1 });
gsapPlugin.addAnimation(tween, 'gameplayAnimations');

// Add multiple animations to global context
const tweens = [
  gsap.to(sprite1, { alpha: 0.5, duration: 1 }),
  gsap.to(sprite2, { rotation: Math.PI, duration: 2 })
];
gsapPlugin.addAnimation(tweens);

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:20

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

IPlugin.addSignalConnection

---

clear()

clear(contextId): void

Defined in: plugins/GSAPPlugin.ts:200

Clears (removes) a specific custom animation context and its tracked animations. If this results in no active contexts, the global collection is recreated if all contexts are cleared.

Parameters

contextId

string

The ID of the animation context to clear

Returns

void

Example

// Clean up completed level animations
gsapPlugin.clear('level1Animations');

---

clearAll()

clearAll(): void

Defined in: plugins/GSAPPlugin.ts:211

Clears all custom animation contexts and recreates the plugin’s global animation collection.

Returns

void

Example

// Complete reset when restarting the game
gsapPlugin.clearAll();

---

clearGlobal()

clearGlobal(): void

Defined in: plugins/GSAPPlugin.ts:244

Clears all animations from the global animation collection managed by this plugin.

Returns

void

Example

// Clear global animations for cleanup
gsapPlugin.clearGlobal();

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:22

Returns

void

Inherited from

IPlugin.clearSignalConnections

---

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:18

Returns

void

Inherited from

IPlugin.destroy

---

getContext()

getContext(contextId): null | Set<Timeline | Tween>

Defined in: plugins/GSAPPlugin.ts:121

Retrieves a custom animation context (a Set of tweens/timelines) by its ID. This is NOT a gsap.Context instance but rather a custom collection for grouping animations.

Parameters

contextId

string

The ID of the animation context

Returns

null | Set<Timeline | Tween>

The animation context (a Set of tweens/timelines) or null if not found

Example

const menuAnimations = gsapPlugin.getContext('menuAnimations');
if (menuAnimations) {
  console.log(`Menu has ${menuAnimations.size} active animations`);
}

---

initialize()

initialize(options, app): void | Promise<void>

Defined in: plugins/Plugin.ts:14

Parameters

options

Partial<O>

app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.initialize

---

killAll()

killAll(contextId?): void

Defined in: plugins/GSAPPlugin.ts:170

Kills (stops and removes) all animations in a specified custom animation context, or all animations. If all contexts are killed, the plugin’s global animation collection is recreated.

Parameters

contextId?

string

Optional ID of the animation context. If omitted, kills all animations

Returns

void

Example

// Kill specific context when transitioning scenes
gsapPlugin.killAll('oldSceneAnimations');

// Emergency stop all animations
gsapPlugin.killAll();

---

killGlobal()

killGlobal(): void

Defined in: plugins/GSAPPlugin.ts:222

Kills all animations within the global animation collection managed by this plugin.

Returns

void

Example

// Stop only global animations, keep context-specific ones
gsapPlugin.killGlobal();

---

pauseAll()

pauseAll(contextId?): void

Defined in: plugins/GSAPPlugin.ts:153

Pauses all animations in a specified custom animation context, or all animations in all contexts.

Parameters

contextId?

string

Optional ID of the animation context. If omitted, pauses all animations

Returns

void

Example

// Pause game animations when menu opens
gsapPlugin.pauseAll('gameplayAnimations');

// Pause everything when app loses focus
gsapPlugin.pauseAll();

---

playAll()

playAll(contextId?): void

Defined in: plugins/GSAPPlugin.ts:137

Plays all animations in a specified custom animation context, or all animations in all contexts.

Parameters

contextId?

string

Optional ID of the animation context. If omitted, plays all animations

Returns

void

Example

// Play all animations in a specific context
gsapPlugin.playAll('gameplayAnimations');

// Play all animations in all contexts
gsapPlugin.playAll();

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:16

Parameters

_app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.postInitialize

---

registerCoreFunctions()

registerCoreFunctions(): void

Defined in: plugins/Plugin.ts:24

Returns

void

Inherited from

IPlugin.registerCoreFunctions

---

registerCoreSignals()

registerCoreSignals(): void

Defined in: plugins/Plugin.ts:26

Returns

void

Inherited from

IPlugin.registerCoreSignals

---

registerCustomEase()

registerCustomEase(name, ease): Ease

Defined in: plugins/GSAPPlugin.ts:87

Registers a custom ease function with GSAP.

Parameters

name

string

The name of the custom ease

ease

EaseFunction

The GSAP ease function

Returns

Ease

An object containing the registered ease

Example

// Register a custom bounce ease
gsapPlugin.registerCustomEase('myBounce', (progress) => {
  return progress < 0.5
    ? 2 * progress * progress
    : 1 - Math.pow(-2 * progress + 2, 3) / 2;
});

// Use the custom ease in animations
gsap.to(mySprite, { x: 200, duration: 1, ease: 'myBounce' });

---

registerEases()

registerEases(eases): Ease

Defined in: plugins/GSAPPlugin.ts:104

Registers multiple custom ease functions with GSAP in batch.

Parameters

eases

Record<string, gsap.EaseFunction>

An object where keys are ease names and values are GSAP ease functions

Returns

Ease

The complete map of registered eases

Example

gsapPlugin.registerEases({
  'softBounce': (t) => t * t * (3 - 2 * t),
  'sharpEase': (t) => t * t * t,
  'customBack': (t) => t * t * (2.7 * t - 1.7)
});

---

revertAll()

revertAll(contextId?): void

Defined in: plugins/GSAPPlugin.ts:186

Reverts all animations in a specified custom animation context to their initial state.

Parameters

contextId?

string

Optional ID of the animation context. If omitted, reverts all animations

Returns

void

Example

// Reset UI animations to initial state
gsapPlugin.revertAll('uiAnimations');

// Reset everything for game restart
gsapPlugin.revertAll();

---

revertGlobal()

revertGlobal(): void

Defined in: plugins/GSAPPlugin.ts:233

Reverts all animations within the global animation collection to their initial state.

Returns

void

Example

// Reset global animations without affecting contexts
gsapPlugin.revertGlobal();