ChatRoomView

Hierarchy

• Pick<ScreenFunctions, Run | MouseDown | MouseUp | MouseMove | MouseWheel | Click | Draw | KeyDown>
  • ChatRoomView

Index

Properties

• Activate
• CanLeave
• CanStartWhisper
• Deactivate
• DisplayMessage
• Draw
• DrawUi
• Screenshot
• SyncRoomProperties

Methods

• Click
• KeyDown
• MouseDown
• MouseMove
• MouseUp
• MouseWheel
• Run

Properties

optionalActivate

Activate?: () => void

Type declaration

• • (): void

  • Returns void

optionalCanLeave

CanLeave?: () => boolean

Type declaration

• • (): boolean

  • Returns boolean

optionalCanStartWhisper

CanStartWhisper?: (C: Character) => boolean

Type declaration

• • (C: Character): boolean

  • Parameters

    • C: Character

    Returns boolean

optionalDeactivate

Deactivate?: () => void

Type declaration

• • (): void

  • Returns void

DisplayMessage

DisplayMessage: (data: ServerChatRoomMessage, msg: string, SenderCharacter: Character, metadata: IChatRoomMessageMetadata) => string

Type declaration

• • (data: ServerChatRoomMessage, msg: string, SenderCharacter: Character, metadata: IChatRoomMessageMetadata): string

  • Parameters

    • data: ServerChatRoomMessage

    • msg: string

    • SenderCharacter: Character

    • metadata: IChatRoomMessageMetadata

    Returns string

Draw

Draw: () => void

Overrides Pick.Draw

Type declaration

• • (): void

  • Returns void

DrawUi

DrawUi: () => void

Type declaration

• • (): void

  • Returns void

Screenshot

Screenshot: () => void

Type declaration

• • (): void

  • Returns void

optionalSyncRoomProperties

SyncRoomProperties?: (data: ServerChatRoomSyncMessage) => void

Type declaration

• • (data: ServerChatRoomSyncMessage): void

  • Parameters

    • data: ServerChatRoomSyncMessage

    Returns void

Methods

Click

• Click(event: MouseEvent | TouchEvent): void

• Inherited from Pick.Click

  Called if the user clicks on the canvas

  ---

  Parameters

  • event: MouseEvent | TouchEvent

    The event that triggered this

  Returns void

optionalKeyDown

• KeyDown(event: KeyboardEvent): boolean

• Inherited from Pick.KeyDown

  Called if the the user presses any key

  ---

  Parameters

  • event: KeyboardEvent

    The event that triggered this

  Returns boolean

optionalMouseDown

• MouseDown(event: MouseEvent | TouchEvent): void

• Inherited from Pick.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 Pick.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 Pick.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 Pick.MouseWheel

  Called if the user moves the mouse wheel on the canvas

  ---

  Parameters

  • event: WheelEvent

    The event that triggered this

  Returns void

Run

• Run(time: number): void

• Inherited from Pick.Run

  Called each frame

  ---

  Parameters

  • time: number

    The current time for frame

  Returns void