Wheel

Class: Wheel

Defined in: core/Wheel.ts:48

A bonus wheel: one or more rings sharing a centre and one typed event stream. Place it like any container; everything else goes through the methods below.

Every method that takes a ring defaults to the main ring, so a single-ring wheel never has to name one:

const spin = wheel.spin();
wheel.setResult({ section: 'x8' });
const result = await spin;

Extends#

Container

Implements#

Disposable

Constructors#

Constructor#

new Wheel(params: WheelParams): Wheel;

Defined in: core/Wheel.ts:54

Parameters#

Parameter	Type
`params`	`WheelParams`

Returns#

Wheel

Overrides#

Container.constructor

Properties#

Property	Modifier	Type	Defined in
`events`	`readonly`	`EventEmitter`<`WheelEvents`>	core/Wheel.ts:49
`idle`	`readonly`	{ `start`: (`config?`: `IdleConfig`, `ring?`: `string`) => `void`; `stop`: (`ring?`: `string`) => `void`; }	core/Wheel.ts:169
`idle.start`	`public`	(`config?`: `IdleConfig`, `ring?`: `string`) => `void`	core/Wheel.ts:170
`idle.stop`	`public`	(`ring?`: `string`) => `void`	core/Wheel.ts:177
`rings`	`readonly`	readonly `Ring`[]	core/Wheel.ts:50

Accessors#

activeSpeed#

Get Signature#

get activeSpeed(): string;

Defined in: core/Wheel.ts:161

Returns

string

geometry#

Get Signature#

get geometry(): RingGeometry;

Defined in: core/Wheel.ts:88

Returns

RingGeometry

isDestroyed#

Get Signature#

get isDestroyed(): boolean;

Defined in: core/Wheel.ts:216

Returns

boolean

Implementation of#

Disposable.isDestroyed

isSpinning#

Get Signature#

get isSpinning(): boolean;

Defined in: core/Wheel.ts:104

Returns

boolean

main#

Get Signature#

get main(): Ring;

Defined in: core/Wheel.ts:67

The main ring: the one WheelBuilder’s top-level section methods configure.

Returns

Ring

radius#

Get Signature#

get radius(): number;

Defined in: core/Wheel.ts:82

The outermost radius across all rings.

Returns

number

rotationDeg#

Get Signature#

get rotationDeg(): number;

Defined in: core/Wheel.ts:96

Returns

number

Set Signature#

set rotationDeg(deg: number): void;

Defined in: core/Wheel.ts:100

Parameters

Parameter	Type
`deg`	`number`

Returns

void

sections#

Get Signature#

get sections(): readonly ResolvedSection[];

Defined in: core/Wheel.ts:92

Returns

readonly ResolvedSection[]

speedNames#

Get Signature#

get speedNames(): string[];

Defined in: core/Wheel.ts:165

Returns

string[]

step#

Get Signature#

get step(): number | null;

Defined in: core/Wheel.ts:201

Returns

number | null

Methods#

destroy()#

destroy(): void;

Defined in: core/Wheel.ts:220

Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

Returns#

void

Example#

container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });

Implementation of#

Disposable.destroy

Overrides#

Container.destroy

hasRing()#

hasRing(id: string): boolean;

Defined in: core/Wheel.ts:77

Parameters#

Parameter	Type
`id`	`string`

Returns#

boolean

highlight()#

highlight(sectionId: string | null, ring?: string): void;

Defined in: core/Wheel.ts:206

Turn a section highlight on (or off with null) on skins that support it.

Parameters#

Parameter	Type
`sectionId`	`string` \| `null`
`ring?`	`string`

Returns#

void

nextStep()#

nextStep(options?: WeightTransitionOptions & {
  ring?: string;
}): Promise<void>;

Defined in: core/Wheel.ts:196

Parameters#

Parameter	Type
`options?`	`WeightTransitionOptions` & { `ring?`: `string`; }

Returns#

Promise<void>

requestSkip()#

requestSkip(ring?: string): void;

Defined in: core/Wheel.ts:136

Parameters#

Parameter	Type
`ring?`	`string`

Returns#

void

ring()#

ring(id: string): Ring;

Defined in: core/Wheel.ts:71

Parameters#

Parameter	Type
`id`	`string`

Returns#

Ring

sectionUnderPointer()#

sectionUnderPointer(pointerId?: string): ResolvedSection;

Defined in: core/Wheel.ts:108

Parameters#

Parameter	Type
`pointerId?`	`string`

Returns#

ResolvedSection

setResult()#

setResult(target: WheelTarget, options?: WheelResultOptions): void;

Defined in: core/Wheel.ts:117

Parameters#

Parameter	Type
`target`	`WheelTarget`
`options`	`WheelResultOptions`

Returns#

void

setSpeed()#

setSpeed(name: string, ring?: string): void;

Defined in: core/Wheel.ts:153

Switch the speed profile on every ring (or one).

Parameters#

Parameter	Type
`name`	`string`
`ring?`	`string`

Returns#

void

setStep()#

setStep(index: number, options?: WeightTransitionOptions & {
  ring?: string;
}): Promise<void>;

Defined in: core/Wheel.ts:191

Parameters#

Parameter	Type
`index`	`number`
`options?`	`WeightTransitionOptions` & { `ring?`: `string`; }

Returns#

Promise<void>

setWeights()#

setWeights(weights: Record<string, number>, options?: WeightTransitionOptions & {
  ring?: string;
}): Promise<void>;

Defined in: core/Wheel.ts:186

Parameters#

Parameter	Type
`weights`	`Record`<`string`, `number`>
`options?`	`WeightTransitionOptions` & { `ring?`: `string`; }

Returns#

Promise<void>

skip()#

skip(ring?: string): boolean;

Defined in: core/Wheel.ts:127

Skip the spinning ring. With one ring in flight this is that ring’s skip(), including its throw before setResult(); with several, every ring that has a result skips. True if any ring skipped.

Parameters#

Parameter	Type
`ring?`	`string`

Returns#

boolean

slamStop()#

slamStop(ring?: string): void;

Defined in: core/Wheel.ts:144

Parameters#

Parameter	Type
`ring?`	`string`

Returns#

void

spin()#

spin(options?: WheelSpinOptions): Promise<WheelSpinResult>;

Defined in: core/Wheel.ts:112

Parameters#

Parameter	Type
`options`	`WheelSpinOptions`

Returns#

Promise<WheelSpinResult>