PIXI-Extended - v0.4.0

Index

Namespaces

Enumerations

Buttons

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ButtonEvent

ButtonEvent: "down" | "up" | "dblclick"

The events that can occurs on any Button.

ColorEvents

ColorEvents: { alphaChange: [value: number]; blueChange: [value: number]; change: [red: number, green: number, blue: number, alpha: number]; greenChange: [value: number]; redChange: [value: number] }

Type declaration

alphaChange: [value: number]
blueChange: [value: number]
change: [red: number, green: number, blue: number, alpha: number]
greenChange: [value: number]
redChange: [value: number]

ContainerEvents

ContainerEvents: SpriteEvents & { childAdded: [child: DisplayObject, container: Container, index: number] }

EventList

EventList: Record<string, any[]>

FPSCounterEvents

FPSCounterEvents: ContainerEvents & { ready: [] }

RGB

RGB: [red: number, green: number, blue: number]

A type containing RGB (red, green, blue) values as a Tuple.

RGBA

RGBA: [red: number, green: number, blue: number, alpha: number]

A type containing RGBA (red, green, blue, alpha) values as a Tuple.

SpriteEvents

SpriteEvents: { added: [container: Container]; click: [event: InteractionEvent]; mousedown: [event: InteractionEvent]; mousemove: [event: InteractionEvent]; mouseout: [event: InteractionEvent]; mouseover: [event: InteractionEvent]; mouseup: [event: InteractionEvent]; mouseupoutside: [event: InteractionEvent]; pointercancel: [event: InteractionEvent]; pointerdown: [event: InteractionEvent]; pointermove: [event: InteractionEvent]; pointerout: [event: InteractionEvent]; pointerover: [event: InteractionEvent]; pointertap: [event: InteractionEvent]; pointerup: [event: InteractionEvent]; pointerupoutside: [event: InteractionEvent]; removed: [container: Container]; removedFrom: [child: DisplayObject, container: Container, index: number]; rightclick: [event: InteractionEvent]; rightdown: [event: InteractionEvent]; rightup: [event: InteractionEvent]; rightupoutside: [event: InteractionEvent]; tap: [event: InteractionEvent]; touchcancel: [event: InteractionEvent]; touchend: [event: InteractionEvent]; touchendoutside: [event: InteractionEvent]; touchmove: [event: InteractionEvent]; touchstart: [event: InteractionEvent] }

Type declaration

added: [container: Container]
click: [event: InteractionEvent]
mousedown: [event: InteractionEvent]
mousemove: [event: InteractionEvent]
mouseout: [event: InteractionEvent]
mouseover: [event: InteractionEvent]
mouseup: [event: InteractionEvent]
mouseupoutside: [event: InteractionEvent]
pointercancel: [event: InteractionEvent]
pointerdown: [event: InteractionEvent]
pointermove: [event: InteractionEvent]
pointerout: [event: InteractionEvent]
pointerover: [event: InteractionEvent]
pointertap: [event: InteractionEvent]
pointerup: [event: InteractionEvent]
pointerupoutside: [event: InteractionEvent]
removed: [container: Container]
removedFrom: [child: DisplayObject, container: Container, index: number]
rightclick: [event: InteractionEvent]
rightdown: [event: InteractionEvent]
rightup: [event: InteractionEvent]
rightupoutside: [event: InteractionEvent]
tap: [event: InteractionEvent]
touchcancel: [event: InteractionEvent]
touchend: [event: InteractionEvent]
touchendoutside: [event: InteractionEvent]
touchmove: [event: InteractionEvent]
touchstart: [event: InteractionEvent]

TextColor

TextColor: Color | Color[]

TextureNameAndPath

TextureNameAndPath: [name: string, path: string]

A tuple containing the texture name and its path.

TextureOrName

TextureOrName: string | Texture

A texture or its name.

TexturesAndName

TexturesAndName: Record<string, Texture>

A record containing textures names as keys, and themselves as values.

TexturesNameAndPath

TexturesNameAndPath: Record<string, string>

A record containing texture names as keys, and their paths as values.

XY

XY: [x: number, y: number]

Variables

Const LeftClick

LeftClick: Button = ...

The LeftClick button handler, usually used.

Const RightClick

RightClick: Button = ...

The RightClick button handler, usually used.

Const buttons

buttons: Set<Button> = ...

The set of buttons created.

Const events

events: EventEmitter<KeyboardEvents> = ...

The EventEmitter to watch the KeyBoard.

Const loadedTexturesNames

loadedTexturesNames: string[] = []

The list of textures loaded via the loadTextures and loadTexture functions.

Const mousePosition

mousePosition: Vector2 = ...

The actual position of the mouse.

remarks: You have to use updateMousePosition every time you want to update this value.

Const pressed

pressed: Set<string> = ...

The Set of keys that are actually pressed.

Functions

bytesToUuid

bytesToUuid(bytes: number[] | Uint8Array): string

- Defined in source/src/utils/random.ts:10
Parameters
- bytes: number[] | Uint8Array
Returns string

clamp

clamp(value: number, min: number, max: number): number

- Defined in source/src/maths/utils.ts:20
Returns a number whose value is limited to the given range.

Parameters
- value: number
  
  The value to clamp.
- min: number
  
  The lower boundary of the output range.
- max: number
  
  The upper boundary of the output range.
Returns number
- A number in the range [min, max].

collisionBoxes

collisionBoxes(box1: Required<IRectangle>, box2: Required<IRectangle>): Hit | null

- Defined in source/src/maths/CollisionsUtils.ts:54
A function to test a collision and get information if colliding.

remarks

Expensive function, if you just want to test collision, prefer using intersect function.

Parameters
- box1: Required<IRectangle>
  
  First rectangle.
- box2: Required<IRectangle>
  
  Second rectangle.
Returns Hit | null
- The Hit result or null it not intersecting.

getColoredTexture

getColoredTexture(application: Application, options: ColoredTextureOptions): Texture

- Defined in source/src/textures/TextureManager.ts:122
Generate a texture from the Application renderer and options.

Parameters
- application: Application
  
  The application, needed to get the renderer.
- options: ColoredTextureOptions
  
  The options of the colored texture.
Returns Texture
- The resulting texture.

getTexture

getTexture(name: string): Texture | null

- Defined in source/src/textures/TextureManager.ts:77
Get a texture from the PIXI.Loader.shared loader, must be present in the loadedTexturesNames to asserts that it has been loaded.

Parameters
- name: string
  
  The name of the texture to search.
Returns Texture | null
- The resulting texture or null if not found.

getTextureOrThrow

getTextureOrThrow(name: string): Texture

- Defined in source/src/textures/TextureManager.ts:89
Get a texture from the PIXI.Loader.shared loader, must be present in the loadedTexturesNames to asserts that it has been loaded.

remarks

Throws an error if the texture was not found in the loadedTexturesNames.

Parameters
- name: string
  
  The name of the texture to search.
Returns Texture
- The resulting texture.

intersect

intersect(first: Required<IRectangle>, second: Required<IRectangle>): boolean

- Defined in source/src/maths/CollisionsUtils.ts:11
Test if two boxes collides.

Parameters
- first: Required<IRectangle>
  
  First box.
- second: Required<IRectangle>
  
  Second box.
Returns boolean
- True if colliding, else false.

isOdd

isOdd(value: number): boolean

- Defined in source/src/maths/utils.ts:9
Returns true if the number is odd.

remarks

Use this function with negation to know if a number is even.

Parameters
- value: number
  
  The number to test.
Returns boolean
- Is the number odd.

isPressed

isPressed(key: Key | Key[]): boolean

- Defined in source/src/interactions/KeyboardManager.ts:31
Test if a key is pressed.

params

key - The key to test.

Parameters
- key: Key | Key[]
Returns boolean
- Is pressed.

loadTexture

loadTexture(name: string, path: string): Promise<Texture>
loadTexture(texturesNameAndPath: TextureNameAndPath): Promise<Texture>

- Defined in source/src/textures/TextureManager.ts:49
Parameters
- name: string
- path: string
Returns Promise<Texture>
- Defined in source/src/textures/TextureManager.ts:50
Parameters
- texturesNameAndPath: TextureNameAndPath
Returns Promise<Texture>

loadTextures

loadTextures(texturesNamesAndPath: TexturesNameAndPath): Promise<TexturesAndName>
loadTextures(texturesNamesAndPath: TextureNameAndPath[]): Promise<TexturesAndName>

- Defined in source/src/textures/TextureManager.ts:27
Parameters
- texturesNamesAndPath: TexturesNameAndPath
Returns Promise<TexturesAndName>
- Defined in source/src/textures/TextureManager.ts:28
Parameters
- texturesNamesAndPath: TextureNameAndPath[]
Returns Promise<TexturesAndName>

map

map(value: number, min1: number, max1: number, min2: number, max2: number): number

- Defined in source/src/maths/utils.ts:33
Map a number from one range to another.

Parameters
- value: number
  
  The value to map.
- min1: number
  
  First range minimum.
- max1: number
  
  First range maximum.
- min2: number
  
  Second range minimum.
- max2: number
  
  Second range maximum.
Returns number
- The number mapped.

random

random(max: number, toInt?: boolean): number
random(min: number, max: number, toInt?: boolean): number
random<T>(array: T[]): T

- Defined in source/src/utils/random.ts:18
Parameters
- max: number
- Optional toInt: boolean
Returns number
- Defined in source/src/utils/random.ts:19
Parameters
- min: number
- max: number
- Optional toInt: boolean
Returns number
- Defined in source/src/utils/random.ts:20
Type parameters
- T
Parameters
- array: T[]
Returns T

randomArray

randomArray<T>(array: T[]): T

- Defined in source/src/utils/random.ts:27
Type parameters
- T
Parameters
- array: T[]
Returns T

randomFloat

randomFloat(max: number): number
randomFloat(min: number, max: number): number

- Defined in source/src/utils/random.ts:31
Parameters
- max: number
Returns number
- Defined in source/src/utils/random.ts:32
Parameters
- min: number
- max: number
Returns number

randomInt

randomInt(max: number): number
randomInt(min: number, max: number): number

- Defined in source/src/utils/random.ts:37
Parameters
- max: number
Returns number
- Defined in source/src/utils/random.ts:38
Parameters
- min: number
- max: number
Returns number

updateMousePosition

updateMousePosition(app: Application): Vector2

- Defined in source/src/interactions/MouseManager.ts:105
Update the mousePosition values. Returns the mouse position itself.

Parameters
- app: Application
  
  The PIXI Application to get the mouse from.
Returns Vector2
- The mouse position itself.

uuidV4

uuidV4(): string

- Defined in source/src/utils/random.ts:1
Returns string

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ButtonEvent

ColorEvents

Type declaration

alphaChange: [value: number]

blueChange: [value: number]

change: [red: number, green: number, blue: number, alpha: number]

greenChange: [value: number]

redChange: [value: number]

ContainerEvents

EventList

FPSCounterEvents

RGB

RGBA

SpriteEvents

Type declaration

added: [container: Container]

click: [event: InteractionEvent]

mousedown: [event: InteractionEvent]

mousemove: [event: InteractionEvent]

mouseout: [event: InteractionEvent]

mouseover: [event: InteractionEvent]

mouseup: [event: InteractionEvent]

mouseupoutside: [event: InteractionEvent]

pointercancel: [event: InteractionEvent]

pointerdown: [event: InteractionEvent]

pointermove: [event: InteractionEvent]

pointerout: [event: InteractionEvent]

pointerover: [event: InteractionEvent]

pointertap: [event: InteractionEvent]

pointerup: [event: InteractionEvent]

pointerupoutside: [event: InteractionEvent]

removed: [container: Container]

removedFrom: [child: DisplayObject, container: Container, index: number]

rightclick: [event: InteractionEvent]

rightdown: [event: InteractionEvent]

rightup: [event: InteractionEvent]

rightupoutside: [event: InteractionEvent]

tap: [event: InteractionEvent]

touchcancel: [event: InteractionEvent]

touchend: [event: InteractionEvent]

touchendoutside: [event: InteractionEvent]

touchmove: [event: InteractionEvent]

touchstart: [event: InteractionEvent]

TextColor

TextureNameAndPath

TextureOrName

TexturesAndName

TexturesNameAndPath

XY

Variables

Const LeftClick

Const RightClick

Const buttons

Const events

Const loadedTexturesNames

Const mousePosition

Const pressed

Functions

bytesToUuid

Parameters

bytes: number[] | Uint8Array

Returns string

clamp

Parameters

value: number

min: number

max: number

Returns number

collisionBoxes

Parameters

box1: Required<IRectangle>