Skip to main content

Util

Index

Namespaces

Functions

References

Namespaces

DrawUtil

DrawUtil:

BorderRadius

BorderRadius:

Represents border radius values

bl

bl: number

Bottom-left

br

br: number

Bottom-right

tl

tl: number

Top-left

tr

tr: number

Top-right

LineCapStyle

LineCapStyle: butt | round | square

A canvas linecap style. "butt" is the default flush style, "round" is a semi-circle cap with a radius half the width of the line, and "square" is a rectangle that is an equal width and half height cap.

circle

  • circle(ctx: CanvasRenderingContext2D, x: number, y: number, radius: number, stroke?: Color, fill?: Color): void

  • Parameters

    • ctx: CanvasRenderingContext2D
    • x: number
    • y: number
    • radius: number
    • stroke: Color = Color.White
    • optionalfill: Color

    Returns void

line

  • line(ctx: CanvasRenderingContext2D, color?: Color, x1: number, y1: number, x2: number, y2: number, thickness?: number, cap?: LineCapStyle): void

  • Draw a line on canvas context

    Parameters

    • ctx: CanvasRenderingContext2D

      The canvas context

    • color: Color = Color.Red

      The color of the line

    • x1: number

      The start x coordinate

    • y1: number

      The start y coordinate

    • x2: number

      The ending x coordinate

    • y2: number

      The ending y coordinate

    • thickness: number = 1

      The line thickness

    • cap: LineCapStyle = 'butt'

      The LineCapStyle (butt, round, or square)

    Returns void

point

  • point(ctx: CanvasRenderingContext2D, color?: Color, point: Vector): void

  • Draw the vector as a point onto the canvas.

    Parameters

    • ctx: CanvasRenderingContext2D
    • color: Color = Color.Red
    • point: Vector

    Returns void

roundRect

  • roundRect(ctx: CanvasRenderingContext2D, x: number, y: number, width: number, height: number, radius?: number | BorderRadius, stroke?: Color | null, fill?: Color | null): void

  • Draw a round rectangle on a canvas context

    Parameters

    • ctx: CanvasRenderingContext2D

      The canvas context

    • x: number

      The top-left x coordinate

    • y: number

      The top-left y coordinate

    • width: number

      The width of the rectangle

    • height: number

      The height of the rectangle

    • radius: number | BorderRadius = 5

      The border radius of the rectangle

    • stroke: Color | null = Color.White

      The Color to stroke rectangle with

    • fill: Color | null = null

      The Color to fill rectangle with

    Returns void

vector

  • vector(ctx: CanvasRenderingContext2D, color: Color, origin: Vector, vector: Vector, scale?: number): void

  • Parameters

    • ctx: CanvasRenderingContext2D
    • color: Color
    • origin: Vector
    • vector: Vector
    • scale: number = 1.0

    Returns void

Functions

addItemToArray

  • addItemToArray<T>(item: T, array: T[]): boolean

  • Add an item to an array list if it doesn't already exist. Returns true if added, false if not and already exists in the array.

    @deprecated

    Will be removed in v0.26.0

    Type parameters

    • T

    Parameters

    • item: T
    • array: T[]

    Returns boolean

contains

  • contains(array: any[], obj: any): boolean

  • See if an array contains something

    Parameters

    • array: any[]
    • obj: any

    Returns boolean

delay

  • delay(milliseconds: number, clock?: Clock): Promise<void>

  • Create a promise that resolves after a certain number of milliseconds

    It is strongly recommended you pass the excalibur clock so delays are bound to the excalibur clock which would be unaffected by stop/pause.

    Parameters

    • milliseconds: number
    • optionalclock: Clock

    Returns Promise<void>

fail

  • fail(message: never): never

  • Used for exhaustive checks at compile time

    Parameters

    • message: never

    Returns never

getMinIndex

  • getMinIndex(array: number[]): number

  • Parameters

    • array: number[]

    Returns number

getPosition

  • getPosition(el: HTMLElement): Vector

  • Find the screen position of an HTML element

    Parameters

    • el: HTMLElement

    Returns Vector

isObject

  • isObject(item: any): item is object

  • Simple object check.

    Parameters

    • item: any

    Returns item is object

mergeDeep

  • mergeDeep<T>(target: T, ...sources: T[]): T

  • Deep merge two objects.

    Type parameters

    • T: object

    Parameters

    • target: T
    • rest...sources: T[]

    Returns T

omit

  • omit<TObject, Keys>(object: TObject, keys: Keys[]): Omit<TObject, Keys>

  • Remove keys from object literals

    Type parameters

    • TObject: Object
    • Keys: string | number | symbol

    Parameters

    • object: TObject
    • keys: Keys[]

    Returns Omit<TObject, Keys>

removeItemFromArray

  • removeItemFromArray<T>(item: T, array: T[]): boolean

  • Remove an item from an list

    @deprecated

    Will be removed in v0.26.0

    Type parameters

    • T

    Parameters

    • item: T
    • array: T[]

    Returns boolean

References

Appender

Re-exports Appender

ConsoleAppender

Re-exports ConsoleAppender

EasingFunction

Re-exports EasingFunction

EasingFunctions

Re-exports EasingFunctions

isLegacyEasing

Re-exports isLegacyEasing

Logger

Re-exports Logger

LogLevel

Re-exports LogLevel

MaybeObserver

Re-exports MaybeObserver

Message

Re-exports Message

Observable

Re-exports Observable

Observer

Re-exports Observer

ScreenAppender

Re-exports ScreenAppender

ScreenAppenderOptions

Re-exports ScreenAppenderOptions

Serializer

Re-exports Serializer
Page Options