Class AirshipChatSingleton

Access using Airship.Chat. Functions for configuring the chat window as well as broadcasting messages.

To send a player a message see Player.SendMessage.

Index

Properties

Methods

BroadcastMessage GiveCommandPermission RegisterCommand RemoveCommandPermission SetUIEnabled

Properties

`Readonly` onChatMessage

onChatMessage: Signal<ChatMessageEvent> = ...

Event fired when a player chats.

If the chat message is a command this will not fire.
Can be cancelled to prevent the message from going through.
Message and nametag can be modified to change what is displayed.
Yielding in a callback will delay the message from being processed.

Methods

BroadcastMessage

BroadcastMessage(message): void
Broadcasts message to entire server, if called from server. Otherwise, broadcasts message to only local player.
Parameters
- message: string
  A message.
Returns void

GiveCommandPermission

GiveCommandPermission(commandLabel, playerId): void
[Server only]

Gives a player permission to use specified chat command
Parameters
- commandLabel: string
- playerId: string
Returns void

RegisterCommand

RegisterCommand(command): void
[Server only]

Registers provided command.
Parameters
- command: ChatCommand
  A command instance.
Returns void

RemoveCommandPermission

RemoveCommandPermission(commandLabel, playerId): void
[Server only]

Revokes a player's permission to use specified chat command
Parameters
- commandLabel: string
- playerId: string
Returns void

SetUIEnabled

SetUIEnabled(val): void
[Client only]

Sets chat's visibility.
Parameters
- val: boolean
  Whether or not chat should be visible.
Returns void