ChatManager

Summary

Methods

Method Returns
SendMessage(message: string) bool
SendMessage(message: string, toTeam: TeamId) bool
SendMessage(message: string, toTeam: TeamId, toSquad: SquadId) bool
SendMessage(message: string, toPlayer: Player) bool
SendMessage(message: string, toPlayers: Player{}) bool
Yell(message: string, duration: float) bool
Yell(message: string, duration: float, toTeam: TeamId) bool
Yell(message: string, duration: float, toTeam: TeamId, toSquad: SquadId) bool
Yell(message: string, duration: float, toPlayer: Player) bool
Yell(message: string, duration: float, toPlayers: Player{}) bool

Methods

SendMessage

SendMessage(message: string): bool

Parameters

Name Type Description
message string Text message to send. Limited to 127 characters.

Returns

Type Description
bool

Example

ChatManager:SendMessage('Hello players!')

SendMessage

SendMessage(message: string, toTeam: TeamId): bool

Parameters

Name Type Description
message string Text message to send. Limited to 127 characters.
toTeam TeamId

Returns

Type Description
bool

Example

ChatManager:SendMessage('Hello Team 1 players!', TeamId.Team1)

SendMessage

SendMessage(message: string, toTeam: TeamId, toSquad: SquadId): bool

Parameters

Name Type Description
message string Text message to send. Limited to 127 characters.
toTeam TeamId
toSquad SquadId

Returns

Type Description
bool

SendMessage

SendMessage(message: string, toPlayer: Player): bool

Parameters

Name Type Description
message string Text message to send. Limited to 127 characters.
toPlayer Player

Returns

Type Description
bool

SendMessage

SendMessage(message: string, toPlayers: Player{}): bool

Parameters

Name Type Description
message string Text message to send. Limited to 127 characters.
toPlayers Player{}

Returns

Type Description
bool

Yell

Yell(message: string, duration: float): bool

Parameters

Name Type Description
message string Text message to send. Limited to 255 characters.
duration float

Returns

Type Description
bool

Yell

Yell(message: string, duration: float, toTeam: TeamId): bool

Parameters

Name Type Description
message string Text message to send. Limited to 255 characters.
duration float
toTeam TeamId

Returns

Type Description
bool

Yell

Yell(message: string, duration: float, toTeam: TeamId, toSquad: SquadId): bool

Parameters

Name Type Description
message string Text message to send. Limited to 255 characters.
duration float
toTeam TeamId
toSquad SquadId

Returns

Type Description
bool

Yell

Yell(message: string, duration: float, toPlayer: Player): bool

Parameters

Name Type Description
message string Text message to send. Limited to 255 characters.
duration float
toPlayer Player

Returns

Type Description
bool

Yell

Yell(message: string, duration: float, toPlayers: Player{}): bool

Parameters

Name Type Description
message string Text message to send. Limited to 255 characters.
duration float
toPlayers Player{}

Returns

Type Description
bool
Last modified May 30, 2020: Add ChatManager yell commands and player-specific variants (ffcd00cf)