BaseChatChannel Class Reference

Inheritance diagram for BaseChatChannel:

Protected Member Functions
void	OnInit (IEntity owner)
event bool	IsDelivering (BaseChatComponent sender, BaseChatComponent receiver)
	Determine, if the message will be delivered to the receiver.
event bool	IsAvailable (BaseChatComponent sender)
	Returns true if the message can be sent to this channel.
event bool	ProcessMessage (BaseChatComponent sender, string message, bool isAuthority)
void	OnInit (IEntity owner)
event bool	IsDelivering (BaseChatComponent sender, BaseChatComponent receiver)
	Determine, if the message will be delivered to the receiver.
event bool	IsAvailable (BaseChatComponent sender)
	Returns true if the message can be sent to this channel.
event bool	ProcessMessage (BaseChatComponent sender, string message, bool isAuthority)

Detailed Description

Definition at line 12 of file BaseChatChannel.c.

Member Function Documentation

IsAvailable() [1/2]

event bool BaseChatChannel::IsAvailable ( BaseChatComponent sender )

inlineprotected

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

Definition at line 27 of file BaseChatChannel.c.

IsAvailable() [2/2]

event bool BaseChatChannel::IsAvailable ( BaseChatComponent sender )

inlineprotected

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

Definition at line 27 of file BaseChatChannel.c.

IsDelivering() [1/2]

event bool BaseChatChannel::IsDelivering ( BaseChatComponent sender, BaseChatComponent receiver )

inlineprotected

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

Definition at line 25 of file BaseChatChannel.c.

IsDelivering() [2/2]

event bool BaseChatChannel::IsDelivering ( BaseChatComponent sender, BaseChatComponent receiver )

inlineprotected

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

Definition at line 25 of file BaseChatChannel.c.

OnInit() [1/2]

void BaseChatChannel::OnInit ( IEntity owner )

protected

OnInit() [2/2]

void BaseChatChannel::OnInit ( IEntity owner )

protected

ProcessMessage() [1/2]

event bool BaseChatChannel::ProcessMessage ( BaseChatComponent sender, string message, bool isAuthority )

inlineprotected

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)

Definition at line 36 of file BaseChatChannel.c.

ProcessMessage() [2/2]

event bool BaseChatChannel::ProcessMessage ( BaseChatComponent sender, string message, bool isAuthority )

inlineprotected

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)

Definition at line 36 of file BaseChatChannel.c.

---

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

• scripts/Game/generated/Chat/BaseChatChannel.c