BaseChatChannel Interface Reference

Inheritance diagram for BaseChatChannel:

Public Member Functions
proto external string	GetName ()
	String identifier of channel.
proto external BaseChatChannelStyle	GetStyle ()
	Returns channel style object.
bool	IsDelivering (BaseChatComponent sender, BaseChatComponent receiver)
	Determine, if the message will be delivered to the receiver.
bool	IsAvailable (BaseChatComponent sender)
	Returns true if the message can be sent to this channel.
bool	ProcessMessage (BaseChatComponent sender, string message, bool isAuthority)
	Method processes chat message before its send to the server and after receiving it by the server.

Protected Member Functions
void	OnInit (IEntity owner)

Member Function Documentation

GetName()

proto external string BaseChatChannel.GetName

(

)

String identifier of channel.

GetStyle()

proto external BaseChatChannelStyle BaseChatChannel.GetStyle

(

)

Returns channel style object.

IsAvailable()

bool BaseChatChannel.IsAvailable

(

BaseChatComponent

sender

)

Returns true if the message can be sent to this channel.

Implemented in SCR_VehicleChatChannel, FactionChatChannel, GroupChatChannel, LocalChatChannel, ServerChatChannel, and SystemChatChannel.

IsDelivering()

bool BaseChatChannel.IsDelivering	(	BaseChatComponent	sender,
		BaseChatComponent	receiver
	)

Determine, if the message will be delivered to the receiver.

Implemented in FactionChatChannel, GroupChatChannel, LocalChatChannel, ServerChatChannel, and SystemChatChannel.

OnInit()

void BaseChatChannel.OnInit ( IEntity  owner )

protected

ProcessMessage()

bool BaseChatChannel.ProcessMessage	(	BaseChatComponent	sender,
		string	message,
		bool	isAuthority
	)

Method processes chat message before its send to the server and after receiving it by the server.

Will be revisited and made osbolete soon

Parameters

message	Chat message
senderChatComp	Senders ChatComponent
isAuthority	true when executed on the server

Returns

Return if the message should be send further through the chat pipeline (send to the server or to the other clients)

Implemented in SystemChatChannel.

---

The documentation for this interface was generated from the following file:

• Game/generated/Chat/BaseChatChannel.c