SP8_GameState_ChatComponent {{ currentPage ? currentPage.title : "" }}

This Component needs to be added to the Game State.

Settings

Channel

Option

Description

DefaultChannels

Set the default Channels.

Example:

Key: Channel

DefaultNameColor: The default Color of the Player Name

DefaultColor: The Default Color of the Message

showMessageOverHead: If true, the Dispatcher “showMessageOverHead” will be called.

visibleToEveryone?: If true, everyone will listen to the Server, without calling AddListener.

Range: If > 0, all Players within a Range will receive the Message. If <= 0, all Players will receive the Message.

Cooldown: How many seconds till the Player can send a new Message (Prevents Spam)

Message

Option

Description

DefaultNameColor

Set the Default Color of the Name, which will be seen inside the Chat Box

DefaultMessageColor

Set the Default Color of the Text, which will be seen inside the Chat Box

Moderation

Option

Description

BlockedWords

Set which Words are not allowed inside any Messages.

Example:

Key: Word, which is not allowed

AddingWarnCount: How many WarnCount’s, the Player will get. Only if MuteMinutes is 0

WarnReason: How many Minutes the Player will be muted. If 0, the Player will only be warned.

Reason: Reason for the Warning/Mute

Functions

Message

Function

Callable

Description

Default Use-Case

SendMessage

Server

Send a Message to other Player.

You have the option between three different types:

- Normal Message: Send a Message into a Channel

- Global Message: Send a Message to everyone

- Private Message: Send a Message to one Person.

Listening

Function

Callable

Description

Default Use-Case

getListener

Server

Get a certain Actor, which is listening to the Game State Chat Component.

getListeners

Server

Get all Players, who are listening to the Game State Chat Component

Could be used to show an online list.

Channel

Function

Callable

Description

Default Use-Case

getChannel

Server

Get the Info of a Channel.

AddChannel

Server

Add a Channel, which can be joined by Players.

Create a Custom Channel for a Guild or Group.

RemoveChannel

Server

Delete a Channel.

A Channel from the DefaultChannel Setting can NOT be removed.

Remove the Channel if the Guild or Group is closed.

Log

Function

Callable

Description

Default Use-Case

SendLogToPlayer

Server

Send a Log to a Player

Could be used as Server Message to a Player or anything else.

Save Load

Function

Callable

Description

Default Use-Case

Save

Server

Save all variables.

Should be called, if the Server is going offline.

Alternative every x Minutes.

Load

Server

Load all variables.

Should be called on start.

Initialize

Server

Set the saved variables.

Only used, if you use your own Save/Load System.

{{{ content }}}