Add
Constructors
new Add()
new Add(
defaultContainer):Add
Parameters
• defaultContainer: Container<DisplayObject>
Returns
Source
Methods
animatedSprite()
animatedSprite(
settings):AnimatedSprite
Parameters
• settings: AnimatedSpriteSettings
Returns
Source
bitmapText()
bitmapText(settings)
bitmapText(
settings?):BitmapText
Parameters
• settings?: BitmapTextSettings
Returns
BitmapText
Source
bitmapText(value, style, alpha, position, anchor, scale)
bitmapText(
value?,style?,alpha?,position?,anchor?,scale?):BitmapText
Parameters
• value?: string
• style?: Partial<IBitmapTextStyle>
• alpha?: number
• position?: PointLike
• anchor?: PointLike
• scale?: PointLike
Returns
BitmapText
Source
coloredSprite()
coloredSprite(settings)
coloredSprite(
settings):Sprite<Application<any>>
Parameters
• settings: ColoredSpriteSettings
Returns
Sprite<Application<any>>
Source
coloredSprite(color, size, shape, opts, alpha, position, anchor, scale)
coloredSprite(
color,size?,shape?,opts?,alpha?,position?,anchor?,scale?):Sprite<Application<any>>
Parameters
• color: number
• size?: PointLike
• shape?: "rectangle" | "circle" | "rounded_rectangle"
• opts?
• alpha?: number
• position?: PointLike
• anchor?: PointLike
• scale?: PointLike
Returns
Sprite<Application<any>>
Source
container()
container(settings)
container(
settings?):Container<Application<any>>
Parameters
• settings?: ContainerSettings
Returns
Container<Application<any>>
Source
container(alpha, position, scale)
container(
alpha?,position?,scale?):Container<Application<any>>
Parameters
• alpha?: number
• position?: PointLike
• scale?: PointLike
Returns
Container<Application<any>>
Source
existing()
existing(pObject, settings)
existing<
T>(pObject,settings):T
Type parameters
• T
Parameters
• pObject: T
• settings: ExistingSettings
Returns
T
Source
existing(pObject, position, anchor, scale)
existing<
T>(pObject,position?,anchor?,scale?):T
Type parameters
• T
Parameters
• pObject: T
• position?: PointLike
• anchor?: PointLike
• scale?: PointLike
Returns
T
Source
flexContainer()
flexContainer(settings)
flexContainer(
settings):FlexContainer
Parameters
• settings: Partial<FlexContainerCreationSettings>
Returns
Source
flexContainer(alpha, position, settings, scale)
flexContainer(
alpha?,position?,settings?,scale?):FlexContainer
Parameters
• alpha?: number
• position?: PointLike
• settings?: Partial<FlexContainerSettings>
• scale?: PointLike
Returns
Source
graphics()
graphics(settings)
graphics(
settings):Graphics
Parameters
• settings: GraphicsSettings
Returns
Graphics
Source
graphics(alpha, position, scale)
graphics(
alpha?,position?,scale?):Graphics
Parameters
• alpha?: number
• position?: PointLike
• scale?: PointLike
Returns
Graphics
Source
htmlText()
htmlText(settings)
htmlText(
settings?):HTMLText
Parameters
• settings?: HTMLTextSettings
Returns
HTMLText
Source
htmlText(value, style, alpha, position, anchor, scale)
htmlText(
value?,style?,alpha?,position?,anchor?,scale?):HTMLText
Parameters
• value?: string
• style?: Partial<HTMLTextStyle | TextStyle | ITextStyle>
• alpha?: number
• position?: PointLike
• anchor?: PointLike
• scale?: PointLike
Returns
HTMLText
Source
mesh()
mesh(settings)
mesh(
settings):Mesh<Shader>
Parameters
• settings: MeshSettings
Returns
Mesh<Shader>
Source
mesh(geometry, shader, state, drawMode)
mesh(
geometry,shader,state?,drawMode?):Mesh<Shader>
Parameters
• geometry: Geometry
• shader: Shader
• state?: State
• drawMode?: DRAW_MODES
Returns
Mesh<Shader>
Source
nineSlice()
nineSlice(settings)
nineSlice(
settings):NineSlicePlane
Parameters
• settings: NineSliceSettings
Returns
NineSlicePlane
Source
nineSlice(asset, sheet, leftWidth, topHeight, rightWidth, bottomHeight, alpha, position, scale)
nineSlice(
asset,sheet?,leftWidth?,topHeight?,rightWidth?,bottomHeight?,alpha?,position?,scale?):NineSlicePlane
Parameters
• asset: string | Texture<Resource>
• sheet?: SpritesheetLike
• leftWidth?: number
• topHeight?: number
• rightWidth?: number
• bottomHeight?: number
• alpha?: number
• position?: PointLike
• scale?: PointLike
Returns
NineSlicePlane
Source
simplePlane()
simplePlane(settings)
simplePlane(
settings):SimplePlane
Parameters
• settings: SimplePlaneSettings
Returns
SimplePlane
Source
simplePlane(asset, sheet, vertsWidth, vertsHeight, alpha, position, scale)
simplePlane(
asset?,sheet?,vertsWidth?,vertsHeight?,alpha?,position?,scale?):SimplePlane
Parameters
• asset?: string | Texture<Resource>
• sheet?: SpritesheetLike
• vertsWidth?: number
• vertsHeight?: number
• alpha?: number
• position?: PointLike
• scale?: PointLike
Returns
SimplePlane
Source
simpleRope()
simpleRope(settings)
simpleRope(
settings):object
Parameters
• settings: SimpleRopeSettings
Returns
object
points
points:
Point[]
rope
rope:
SimpleRope
Source
simpleRope(asset, sheet, numPoints, segmentLength, autoUpdate, alpha, position, scale)
simpleRope(
asset,sheet?,numPoints?,segmentLength?,autoUpdate?,alpha?,position?,scale?):object
Parameters
• asset: string | Texture<Resource>
• sheet?: SpritesheetLike
• numPoints?: number
• segmentLength?: number
• autoUpdate?: boolean
• alpha?: number
• position?: PointLike
• scale?: PointLike
Returns
object
points
points:
Point[]
rope
rope:
SimpleRope
Source
spine()
spine(
settings):Spine
Parameters
• settings: SpineSettings
Returns
Spine
Source
sprite()
sprite(settings)
sprite(
settings):Sprite<Application<any>>
Parameters
• settings: SpriteSettings
Returns
Sprite<Application<any>>
Source
sprite(pTexture, pSheet, alpha, position, anchor, scale)
sprite(
pTexture,pSheet?,alpha?,position?,anchor?,scale?):Sprite<Application<any>>
Parameters
• pTexture: string | Texture<Resource>
• pSheet?: SpritesheetLike
• alpha?: number
• position?: PointLike
• anchor?: PointLike
• scale?: PointLike
Returns
Sprite<Application<any>>
Source
text()
text(value, style, alpha, position, anchor, scale)
text(
value?,style?,alpha?,position?,anchor?,scale?):Text
Parameters
• value?: string
• style?: Partial<TextStyle | ITextStyle>
• alpha?: number
• position?: PointLike
• anchor?: PointLike
• scale?: PointLike
Returns
Text
Source
text(settings)
text(
settings):Text
Parameters
• settings: TextSettings
Returns
Text
Source
tilingSprite()
tilingSprite(settings)
tilingSprite(
settings):TilingSprite
Parameters
• settings: TilingSpriteSettings
Returns
TilingSprite
Source
tilingSprite(asset, sheet, width, height, tilePosition, alpha, position, anchor, scale)
tilingSprite(
asset,sheet,width,height,tilePosition?,alpha?,position?,anchor?,scale?):TilingSprite
Parameters
• asset: string | Texture<Resource>
• sheet: SpritesheetLike
• width: number
• height: number
• tilePosition?: PointLike
• alpha?: number
• position?: PointLike
• anchor?: PointLike
• scale?: PointLike
Returns
TilingSprite
Source
uiCanvas()
uiCanvas(
settings):UICanvas
Parameters
• settings: UICanvasMakeSettings