Anywhere Teacher Activity Project Documentation
Options
All
  • Public
  • Public/Protected
  • All
Menu

Collection of common utilities and helper methods

Hierarchy

  • Utilities

Index

Methods

Methods

Static addDropShadow

  • addDropShadow(_sprite: Sprite, _context: State, _xOffset?: number, _yOffset?: number, _alpha?: number): void

  • Add a dropshadow to the given Phaser Sprite

    Parameters

    • _sprite: Sprite

      Sprite to which to add the drop shadow

    • _context: State
    • Default value _xOffset: number = 10

      Shadow's x offset (default: 10)

    • Default value _yOffset: number = 10

      Shadow's y offset (default: 10)

    • Default value _alpha: number = 0.2

      Shadow's alpha value (default: 0.2)

    Returns void

Static getMicroserviceUrl

  • getMicroserviceUrl(baseUrl: string, apiPath: string, stage?: string): string

  • Returns a formatted url for a SZ microservice

    Parameters

    • baseUrl: string

      The base url of the microservice

    • apiPath: string

      The relative url path to the api endpoint

    • Optional stage: string

      (Optional) The microservice stage. If undefined, the current host will be used to determine the appropriate stage

    Returns string

Static getRandomBool

  • getRandomBool(): boolean

  • Get a random boolean value

    Returns boolean

    Random boolean

Static getRandomInteger

  • getRandomInteger(min: number, max: number): number

  • Get a random integer value within the range [min..max]

    Parameters

    • min: number

      Min value

    • max: number

      Max value

    Returns number

    Random number

Static getScaleToFill

  • getScaleToFill(target: DisplayObjectContainer | { height: number; width: number }, fillIn: DisplayObjectContainer | { height: number; width: number }, percent?: number): { newHeight: number; newWidth: number; scale: number }

  • Calculate the dimensions and scale needed in order to fill an object within another (new bounds may exceed the bounds of the object to fill in)

    Parameters

    • target: DisplayObjectContainer | { height: number; width: number }

      The display object we want to calculate new dimensions and scale for

    • fillIn: DisplayObjectContainer | { height: number; width: number }

      The display object to use as a reference to fit it

    • Default value percent: number = 1

      The percentage to fill within fitIn [0..1]. If 1, the horizontal or vertical dimension of target will match the width or height of fillIn

    Returns { newHeight: number; newWidth: number; scale: number }

    • newHeight: number
    • newWidth: number
    • scale: number

Static getScaleToFit

  • getScaleToFit(target: DisplayObjectContainer | { height: number; width: number }, fitIn: DisplayObjectContainer | { height: number; width: number }, percent?: number): { newHeight: number; newWidth: number; scale: number }

  • Calculate the dimensions and scale needed in order to fit an object within another (new bounds will not exceed the bounds of the object fitting in)

    Parameters

    • target: DisplayObjectContainer | { height: number; width: number }

      The display object we want to calculate new dimensions and scale for

    • fitIn: DisplayObjectContainer | { height: number; width: number }

      The display object to use as a reference to fit it

    • Default value percent: number = 1

      The percentage to fill within fitIn [0..1]. If 1, the horizontal or vertical dimension of target will match the width or height of fitIn

    Returns { newHeight: number; newWidth: number; scale: number }

    • newHeight: number
    • newWidth: number
    • scale: number

Static isRunningOnDevelopmentHost

  • isRunningOnDevelopmentHost(): boolean

  • Returns true if currently running from a development server

    Returns boolean

Static pulseTween

  • pulseTween(_sprite: Sprite, _context?: State, _xScale?: number, _yScale?: number, _duration?: number, _callback?: Function): void

  • Uses a Phaser Tween to pulse the scale of a Phaser Sprite

    Parameters

    • _sprite: Sprite

      Sprite to pulse

    • Optional _context: State
    • Default value _xScale: number = 1.2

      X Scale to tween to before returning (default: 1.2)

    • Default value _yScale: number = 1.2

      Y Scale to tween to before returning (default: 1.2)

    • Default value _duration: number = 200

      Tween duration in ms (default: 200)

    • Optional _callback: Function

      Optional callback after tween is complete

    Returns void

Static roundCorners

  • roundCorners(sprite: Sprite, radius: number, borderWidth?: number, borderColor?: number): void

  • Round the corners of a sprite

    Parameters

    • sprite: Sprite

      The sprite to apply rounded corners on

    • radius: number

      Radius of each corner

    • Optional borderWidth: number

      Width in pixels of border (if any)

    • Optional borderColor: number

      Color of border, if width is defined

    Returns void

Static shuffle

  • shuffle<T>(t: T[]): T[]

  • Shuffle the elements of an array

    Type parameters

    • T

    Parameters

    • t: T[]

      The array

    Returns T[]