BaseChatEntity Interface Reference

Inheritance diagram for BaseChatEntity:

Public Member Functions
proto external int	GetChannelsCount ()
proto external string	GetChannelName (int channelId)
proto external BaseChatChannel	GetChannel (int channelId)
proto external PrivateMessageChannel	GetWhisperChannel ()
proto external BaseChatChannel	GetDefaultChannel ()
proto external BaseChatChannelStyle	GetStyle ()

Member Function Documentation

GetChannel()

proto external BaseChatChannel BaseChatEntity.GetChannel

(

int

channelId

)

Parameters

[channelId]

Channel ID indexed from 0.

Returns

Channel or null if ID is invalid

GetChannelName()

proto external string BaseChatEntity.GetChannelName

(

int

channelId

)

Parameters

[channelId]

Defined by BaseChatEntity. Indexed from 0.

Returns

Name of channel as defined in BaseChatEntity

GetChannelsCount()

proto external int BaseChatEntity.GetChannelsCount

(

)

Returns

Total number of channels

GetDefaultChannel()

proto external BaseChatChannel BaseChatEntity.GetDefaultChannel

(

)

Returns

Returns the channel which was setup as default

GetStyle()

proto external BaseChatChannelStyle BaseChatEntity.GetStyle

(

)

Returns

Base channel style object.

GetWhisperChannel()

proto external PrivateMessageChannel BaseChatEntity.GetWhisperChannel

(

)

Returns

Channel or null if no whisper channel is configured

---

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

• Game/generated/Entities/BaseChatEntity.c