Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_ChatComponent Interface Reference
Inheritance diagram for SCR_ChatComponent:
BaseChatComponent GameComponent

Public Member Functions

bool GetChannelState (BaseChatChannel channelId)
 
override void OnNewMessage (string msg, int channelId, int senderId)
 Event triggered on every message delivered to BaseChatComponent.
 
override void OnNewPrivateMessage (string msg, int senderId, int receiverId)
 Event triggered on every private message delivered to BaseChatComponent.
 
override void ShowMessage (string msg)
 
- Public Member Functions inherited from BaseChatComponent
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 ()
 

Static Public Member Functions

static void RadioProtocolMessage (string msg, int freq=-1)
 API method for the radio protocol use.
 

Additional Inherited Members

Member Function Documentation

◆ GetChannelState()

bool SCR_ChatComponent.GetChannelState ( BaseChatChannel channelId)
Parameters
[in]channelId
Returns

◆ OnNewMessage()

override void SCR_ChatComponent.OnNewMessage ( string msg,
int channelId,
int senderId )

Event triggered on every message delivered to BaseChatComponent.

Parameters
msgPayload
channelIdDefined by BaseChatEntity. Indexed from 0.
senderIdSender PlayerID compatible with lobby

Implements BaseChatComponent.

◆ OnNewPrivateMessage()

override void SCR_ChatComponent.OnNewPrivateMessage ( string msg,
int senderId,
int receiverId )

Event triggered on every private message delivered to BaseChatComponent.

Parameters
msgPayload
senderIdSender PlayerID
receiverIdReceiver PlayerID

Implements BaseChatComponent.

◆ RadioProtocolMessage()

static void SCR_ChatComponent.RadioProtocolMessage ( string msg,
int freq = -1 )
static

API method for the radio protocol use.

Prints the radio protocol message into the chat.

Parameters
[in]msg
[in]freq

◆ ShowMessage()

override void SCR_ChatComponent.ShowMessage ( string msg)

Implements BaseChatComponent.


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