ShopScreenFunctions

Hierarchy

• Omit<Partial<ScreenFunctions>, Draw>
  • ShopScreenFunctions

Index

Properties

• Coords
• Mode

Methods

• Click
• Draw
• Exit
• KeyDown
• KeyUp
• Load
• MouseDown
• MouseMove
• MouseUp
• MouseWheel
• Resize
• Run
• Unload

Properties

Coords

Coords: RectTuple

Coordinates associated with a particular to-be drawn/clicked element

Mode

Mode: Set<ShopMode>

A set of shop modes for which the screen functions must be active

Methods

optionalClick

• Click(event: MouseEvent | TouchEvent): void

• Inherited from Omit.Click

  Called if the user clicks on the canvas

  ---

  Parameters

  • event: MouseEvent | TouchEvent

    The event that triggered this

  Returns void

Draw

• Draw(...coords: RectTuple): void

• Parameters

  • rest...coords: RectTuple

  Returns void

optionalExit

• Exit(): void

• Inherited from Omit.Exit

  Called when user presses Esc

  ---

  Returns void

optionalKeyDown

• KeyDown(event: KeyboardEvent): boolean

• Inherited from Omit.KeyDown

  Called if the the user presses any key

  ---

  Parameters

  • event: KeyboardEvent

    The event that triggered this

  Returns boolean

optionalKeyUp

• KeyUp(event: KeyboardEvent): void

• Inherited from Omit.KeyUp

  Called if the user releases a pressed key

  ---

  Parameters

  • event: KeyboardEvent

    The event that triggered this

  Returns void

optionalLoad

• Load(): void

• Inherited from Omit.Load

  Called when screen is loaded using CommonSetScreen

  ---

  Returns void

optionalMouseDown

• MouseDown(event: MouseEvent | TouchEvent): void

• Inherited from Omit.MouseDown

  Called if the user presses the mouse button or touches the touchscreen on the canvas

  ---

  Parameters

  • event: MouseEvent | TouchEvent

    The event that triggered this

  Returns void

optionalMouseMove

• MouseMove(event: MouseEvent | TouchEvent): void

• Inherited from Omit.MouseMove

  Called if the user moves the mouse cursor or the touch on the touchscreen over the canvas

  ---

  Parameters

  • event: MouseEvent | TouchEvent

    The event that triggered this

  Returns void

optionalMouseUp

• MouseUp(event: MouseEvent | TouchEvent): void

• Inherited from Omit.MouseUp

  Called if the user releases the mouse button or the touchscreen on the canvas

  ---

  Parameters

  • event: MouseEvent | TouchEvent

    The event that triggered this

  Returns void

optionalMouseWheel

• MouseWheel(event: WheelEvent): void

• Inherited from Omit.MouseWheel

  Called if the user moves the mouse wheel on the canvas

  ---

  Parameters

  • event: WheelEvent

    The event that triggered this

  Returns void

optionalResize

• Resize(load: boolean): void

• Inherited from Omit.Resize

  Called when screen size or position changes or after screen load

  ---

  Parameters

  • load: boolean

    If the reason for call was load (true) or window resize (false)

  Returns void

optionalRun

• Run(time: number): void

• Inherited from Omit.Run

  Called each frame

  ---

  Parameters

  • time: number

    The current time for frame

  Returns void

optionalUnload

• Unload(): void

• Inherited from Omit.Unload

  Called when this screen is being replaced

  ---

  Returns void