Options
All
  • Public
  • Public/Protected
  • All
Menu

An icon representing a Door Control

Hierarchy

  • any
    • DoorControl

Index

Constructors

  • Parameters

    • wall: any

    Returns DoorControl

Properties

wall: any
visible: boolean
bg: any
icon: any
border: any
interactive: boolean
interactiveChildren: boolean
hitArea: Rectangle
buttonMode: boolean
alpha: number

Accessors

  • get center(): any
  • The center of the wall which contains the door.

    Returns any

  • 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 the DoorControl icon, displaying its icon texture and border

    Returns Promise<DoorControl>

  • _getTexture(): Texture
  • Get the icon texture to use for the Door Control icon based on the door state

    Returns Texture

  • reposition(): void
  • Returns void

  • _onMouseOver(event: InteractionEvent): boolean
  • Handle mouse over events on a door control icon.

    Parameters

    • event: InteractionEvent

      The originating interaction event

    Returns boolean

  • _onMouseOut(event: InteractionEvent): boolean
  • Handle mouse out events on a door control icon.

    Parameters

    • event: InteractionEvent

      The originating interaction event

    Returns boolean

  • _onMouseDown(event: InteractionEvent): any
  • Handle left mouse down events on a door control icon. This should only toggle between the OPEN and CLOSED states.

    Parameters

    • event: InteractionEvent

      The originating interaction event

    Returns any

  • _onRightDown(event: InteractionEvent): any
  • Handle right mouse down events on a door control icon. This should toggle whether the door is LOCKED or CLOSED.

    Parameters

    • event: InteractionEvent

      The originating interaction event

    Returns any