PixiProgressBar
Defined in: ui/src/pixi-ui/PixiProgressBar.ts:7
Yoga-aware wrapper around @pixi/ui ProgressBar.
Extends
Section titled “Extends”PixiUIBase<ProgressBar>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new PixiProgressBar(
props):PixiProgressBar
Defined in: ui/src/pixi-ui/PixiProgressBar.ts:8
Parameters
Section titled “Parameters”Returns
Section titled “Returns”PixiProgressBar
Overrides
Section titled “Overrides”Properties
Section titled “Properties”prevProps
Section titled “prevProps”
protectedprevProps:Record<string,unknown> ={}
Defined in: ui/src/pixi-ui/PixiUIBase.ts:17
Inherited from
Section titled “Inherited from”
protectedreadonlyview:ProgressBar
Defined in: ui/src/pixi-ui/PixiUIBase.ts:16
Inherited from
Section titled “Inherited from”yogaNode
Section titled “yogaNode”
readonlyyogaNode:Node
Defined in: ui/src/pixi-ui/PixiUIBase.ts:15
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”displayObject
Section titled “displayObject”Get Signature
Section titled “Get Signature”get displayObject():
DisplayContainer
Defined in: ui/src/pixi-ui/PixiUIBase.ts:19
Returns
Section titled “Returns”DisplayContainer
Inherited from
Section titled “Inherited from”visible
Section titled “visible”Get Signature
Section titled “Get Signature”get visible():
boolean
Defined in: ui/src/pixi-ui/PixiUIBase.ts:23
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set visible(
v):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:27
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”applyLayout()
Section titled “applyLayout()”applyLayout():
void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:56
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”bridgeSignal()
Section titled “bridgeSignal()”
protectedbridgeSignal<F>(signal,key,newProps):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:62
Bridge a @pixi/ui Signal to a callback prop. Only reconnects if ref changed.
Type Parameters
Section titled “Type Parameters”F extends (…args) => void
Parameters
Section titled “Parameters”signal
Section titled “signal”connect
Section titled “connect”(cb) => void
disconnect
Section titled “disconnect”(cb) => void
string
newProps
Section titled “newProps”Record<string, unknown>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:84
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”disconnectAll()
Section titled “disconnectAll()”
protecteddisconnectAll():void
Defined in: ui/src/pixi-ui/PixiProgressBar.ts:29
Override in subclass to disconnect all signals on destroy.
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”update()
Section titled “update()”update(
props):void
Defined in: ui/src/pixi-ui/PixiProgressBar.ts:21
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”updateBase()
Section titled “updateBase()”
protectedupdateBase(props):void
Defined in: ui/src/pixi-ui/PixiUIBase.ts:76
Apply layout props, visible, and store prevProps. Call at end of subclass update().
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void