ChatRoomView

Hierarchy

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

Index

Properties

• Activate
• CanLeave
• CanStartWhisper
• Click
• Deactivate
• DisplayMessage
• Draw
• DrawUi
• KeyDown
• MouseDown
• MouseMove
• MouseUp
• MouseWheel
• Run
• Screenshot
• SyncRoomProperties

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

Click

Click: MouseEventListener

Inherited from Pick.Click

Called if the user clicks on the canvas

@param

The event that triggered this

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

optionalKeyDown

KeyDown?: KeyboardEventListener

Inherited from Pick.KeyDown

Called if the the user presses any key

@param

The event that triggered this

optionalMouseDown

MouseDown?: MouseEventListener

Inherited from Pick.MouseDown

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

@param

The event that triggered this

optionalMouseMove

MouseMove?: MouseEventListener

Inherited from Pick.MouseMove

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

@param

The event that triggered this

optionalMouseUp

MouseUp?: MouseEventListener

Inherited from Pick.MouseUp

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

@param

The event that triggered this

optionalMouseWheel

MouseWheel?: MouseWheelEventListener

Inherited from Pick.MouseWheel

Called if the user moves the mouse wheel on the canvas

@param

The event that triggered this

Run

Run: ScreenRunHandler

Inherited from Pick.Run

Called each frame

@param

The current time for frame

Screenshot

Screenshot: () => void

Type declaration

• • (): void

  • Returns void

optionalSyncRoomProperties

SyncRoomProperties?: (data: ServerChatRoomSyncMessage) => void

Type declaration

• • (data: ServerChatRoomSyncMessage): void

  • Parameters

    • data: ServerChatRoomSyncMessage

    Returns void