Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DoorControl

An icon representing a Door Control

Hierarchy

  • any
    • DoorControl

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • wall: any

    Returns DoorControl

Properties

wall

wall: any

visible

visible: boolean

bg

bg: any

icon

icon: any

border

border: any

eventMode

eventMode: string

interactiveChildren

interactiveChildren: boolean

hitArea

hitArea: Rectangle

cursor

cursor: string

alpha

alpha: number

Accessors

center

  • get center(): any

  • The center of the wall which contains the door.

    Returns any

isVisible

  • get isVisible(): boolean

  • Determine whether the DoorControl is visible to the calling user's perspective. The control is always visible if the user is a GM and no Tokens are controlled.

    see

    {CanvasVisibility#testVisibility}

    Returns boolean

Methods

draw

  • Draw the DoorControl icon, displaying its icon texture and border

    Returns Promise<DoorControl>

_getTexture

  • _getTexture(): Texture

  • Get the icon texture to use for the Door Control icon based on the door state

    Returns Texture

reposition

  • reposition(): void

  • Returns void

Protected _onMouseOver

  • _onMouseOver(event: FederatedEvent): boolean

  • Handle mouse over events on a door control icon.

    Parameters

    • event: FederatedEvent

      The originating interaction event

    Returns boolean

Protected _onMouseOut

  • _onMouseOut(event: FederatedEvent): boolean

  • Handle mouse out events on a door control icon.

    Parameters

    • event: FederatedEvent

      The originating interaction event

    Returns boolean

Protected _onMouseDown

  • _onMouseDown(event: FederatedEvent): any

  • Handle left mouse down events on a door control icon. This should only toggle between the OPEN and CLOSED states.

    Parameters

    • event: FederatedEvent

      The originating interaction event

    Returns any

Protected _onRightDown

  • _onRightDown(event: FederatedEvent): any

  • Handle right mouse down events on a door control icon. This should toggle whether the door is LOCKED or CLOSED.

    Parameters

    • event: FederatedEvent

      The originating interaction event

    Returns any