BaseChatComponent Interface Reference

This component takes care of sending chat messages. More...

Inheritance diagram for BaseChatComponent:

Public Member Functions
proto external IEntity	GetOwner ()
	Returns the parent entity of this component.
proto external void	SetChannel (int channelId, bool enabled)
	Enables/disables chat-channel.
proto external bool	GetChannelState (int channelId)
proto external void	SendMessage (string msgStr, int channelId)
	Send message to specified channel.
proto external void	SendPrivateMessage (string msgStr, int receiverId)
	Send message to specific player.
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Protected Member Functions
void	OnNewMessage (string msg, int channelId, int senderId)
	Event triggered on every message delivered to BaseChatComponent.
void	OnNewPrivateMessage (string msg, int senderId, int receiverId)
	Event triggered on every private message delivered to BaseChatComponent.
void	ShowMessage (string msg)

Detailed Description

This component takes care of sending chat messages.

Member Function Documentation

GetChannelState()

proto external bool BaseChatComponent.GetChannelState

(

int

channelId

)

Parameters

channelId

Defined by BaseChatEntity. Indexed from 0.

Returns

true for enabled channel, false otherwise

GetOwner()

proto external IEntity BaseChatComponent.GetOwner

(

)

Returns the parent entity of this component.

OnNewMessage()

void BaseChatComponent.OnNewMessage ( string msg, int channelId, int senderId )

protected

Event triggered on every message delivered to BaseChatComponent.

Parameters

msg	Payload
channelId	Defined by BaseChatEntity. Indexed from 0.
senderId	Sender PlayerID compatible with lobby

Implemented in SCR_ChatComponent.

OnNewPrivateMessage()

void BaseChatComponent.OnNewPrivateMessage ( string msg, int senderId, int receiverId )

protected

Event triggered on every private message delivered to BaseChatComponent.

Parameters

msg	Payload
senderId	Sender PlayerID
receiverId	Receiver PlayerID

Implemented in SCR_ChatComponent.

SendMessage()

proto external void BaseChatComponent.SendMessage	(	string	msgStr,
		int	channelId )

Send message to specified channel.

Parameters

msgStr	Message to be sent
channelId	Defined by BaseChatEntity. Indexed from 0.

SendPrivateMessage()

proto external void BaseChatComponent.SendPrivateMessage	(	string	msgStr,
		int	receiverId )

Send message to specific player.

Parameters

msgStr	Message to be sent
receiverId	Receiver PlayerID

SetChannel()

proto external void BaseChatComponent.SetChannel	(	int	channelId,
		bool	enabled )

Enables/disables chat-channel.

System channel (channelId = 0) is enabled by default

Parameters

channelId	Defined by BaseChatEntity. Indexed from 0.
enabled	Enable/disable receiving of messages in channel

ShowMessage()

void BaseChatComponent.ShowMessage ( string msg )

protected

Implemented in SCR_ChatComponent.

---

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

• Game/generated/Components/BaseChatComponent.c