SpineRingSkin

Class: SpineRingSkin

Defined in: spine/SpineRingSkin.ts:54

A ring drawn by a Spine skeleton. The wheel disc is a bone the engine rotates; the skeleton’s own animations carry glow loops, bulb chases and landing celebrations, wired to the spin events by name.

Import from pixi-wheels/spine; the runtime is a peer dependency.

Implements#

RingSkin

Constructors#

Constructor#

new SpineRingSkin(options: SpineRingSkinOptions): SpineRingSkin;

Defined in: spine/SpineRingSkin.ts:65

Parameters#

Parameter	Type
`options`	`SpineRingSkinOptions`

Returns#

SpineRingSkin

Properties#

Property	Modifier	Type	Defined in
`spine`	`readonly`	`Spine`	spine/SpineRingSkin.ts:55

Accessors#

isDestroyed#

Get Signature#

get isDestroyed(): boolean;

Defined in: spine/SpineRingSkin.ts:163

Returns

boolean

Implementation of#

RingSkin.isDestroyed

labels#

Get Signature#

get labels(): SectionLabels | null;

Defined in: spine/SpineRingSkin.ts:122

The label layer, when labels is on.

Returns

SectionLabels | null

Methods#

attach()#

attach(ctx: RingSkinContext): void;

Defined in: spine/SpineRingSkin.ts:93

Parameters#

Parameter	Type
`ctx`	`RingSkinContext`

Returns#

void

Implementation of#

RingSkin.attach

destroy()#

destroy(): void;

Defined in: spine/SpineRingSkin.ts:167

Returns#

void

Implementation of#

RingSkin.destroy

layout()#

layout(): void;

Defined in: spine/SpineRingSkin.ts:109

Returns#

void

Implementation of#

RingSkin.layout

onLanded()#

onLanded(section: ResolvedSection): void;

Defined in: spine/SpineRingSkin.ts:134

Parameters#

Parameter	Type
`section`	`ResolvedSection`

Returns#

void

Implementation of#

RingSkin.onLanded

onSpinStart()#

onSpinStart(): void;

Defined in: spine/SpineRingSkin.ts:126

Hooks the ring calls from its own event stream, for skins with spin / win states.

Returns#

void

Implementation of#

RingSkin.onSpinStart

onSpinStop()#

onSpinStop(): void;

Defined in: spine/SpineRingSkin.ts:130

Returns#

void

Implementation of#

RingSkin.onSpinStop

play()#

play(name: string, loop?: boolean): void;

Defined in: spine/SpineRingSkin.ts:147

Play any animation on the wheel track. Missing names are skipped with one warning.

Parameters#

Parameter	Type	Default value
`name`	`string`	`undefined`
`loop`	`boolean`	`false`

Returns#

void

syncRotation()#

syncRotation(rotationDeg: number): void;

Defined in: spine/SpineRingSkin.ts:115

Every frame, the disc rotation in degrees. For upright labels and bone-driven skins.

Parameters#

Parameter	Type
`rotationDeg`	`number`

Returns#

void

Implementation of#

RingSkin.syncRotation