Interface: ClientEvents
Internal.ClientEvents
Properties
bulleConnect
• bulleConnect: (connection: Connection) => void
Emitted when a connection with the game server (bulle) is established.
Type declaration
▸ (connection): void
Parameters
| Name | Type |
|---|---|
connection | Connection |
Returns
void
bulleConnectionError
• bulleConnectionError: (err: Error) => void
Emitted when connection to the game server (bulle) failed.
Type declaration
▸ (err): void
Parameters
| Name | Type |
|---|---|
err | Error |
Returns
void
channelJoin
• channelJoin: (channel: Channel) => void
Emitted when client joined a chat channel
Type declaration
▸ (channel): void
Parameters
| Name | Type |
|---|---|
channel | Channel |
Returns
void
channelLeave
• channelLeave: (channel: Channel) => void
Emitted when client left a chat channel
Type declaration
▸ (channel): void
Parameters
| Name | Type |
|---|---|
channel | Channel |
Returns
void
channelMessage
• channelMessage: (channelMessage: ChannelMessage) => void
Emitted when a message is sent to a channel
Type declaration
▸ (channelMessage): void
Parameters
| Name | Type |
|---|---|
channelMessage | ChannelMessage |
Returns
void
channelWho
• channelWho: (channel: Channel, players: TribullePlayer[], fingerprint: number) => void
Emitted when received /who result
Type declaration
▸ (channel, players, fingerprint): void
Parameters
| Name | Type |
|---|---|
channel | Channel |
players | TribullePlayer[] |
fingerprint | number |
Returns
void
connect
• connect: (connection: Connection) => void
Emitted when a connection with the main server is established.
Type declaration
▸ (connection): void
Parameters
| Name | Type |
|---|---|
connection | Connection |
Returns
void
connectionError
• connectionError: (err: Error) => void
Emitted when connection to the main server failed.
Type declaration
▸ (err): void
Parameters
| Name | Type |
|---|---|
err | Error |
Returns
void
disconnect
• disconnect: (err?: TFMConnectionError) => void
Emitted when the client has disconnected.
Type declaration
▸ (err?): void
Parameters
| Name | Type |
|---|---|
err? | TFMConnectionError |
Returns
void
friendAdd
• friendAdd: (friend: Friend) => void
Emitted when a friend is added to friend list
Type declaration
▸ (friend): void
Parameters
| Name | Type |
|---|---|
friend | Friend |
Returns
void
friendConnect
• friendConnect: (friend: Friend) => void
Emitted when a friend is connected
Type declaration
▸ (friend): void
Parameters
| Name | Type |
|---|---|
friend | Friend |
Returns
void
friendDisconnect
• friendDisconnect: (friend: Friend) => void
Emitted when a friend is disconnected
Type declaration
▸ (friend): void
Parameters
| Name | Type |
|---|---|
friend | Friend |
Returns
void
friendList
• friendList: (friends: Map<string, Friend>) => void
Emitted when the client received the friend list
Type declaration
▸ (friends): void
Parameters
| Name | Type |
|---|---|
friends | Map<string, Friend> |
Returns
void
friendRemove
• friendRemove: (friend: Friend) => void
Emitted when a friend is removed from friend list
Type declaration
▸ (friend): void
Parameters
| Name | Type |
|---|---|
friend | Friend |
Returns
void
friendUpdate
• friendUpdate: (friendNew: Friend, friendOld: Friend) => void
Emitted when friend state is changed (e.g. room, gender).
Type declaration
▸ (friendNew, friendOld): void
Parameters
| Name | Type |
|---|---|
friendNew | Friend |
friendOld | Friend |
Returns
void
login
• login: (name: string, pcode: number) => void
Emitted when the client has logged in.
Type declaration
▸ (name, pcode): void
Parameters
| Name | Type |
|---|---|
name | string |
pcode | number |
Returns
void
loginError
• loginError: (code: number, error1: string, error2: string) => void
Emitted when the client failed to log in.
Type declaration
▸ (code, error1, error2): void
Parameters
| Name | Type |
|---|---|
code | number |
error1 | string |
error2 | string |
Returns
void
loginReady
• loginReady: () => void
Emitted when the client can login on the game.
Type declaration
▸ (): void
Returns
void
luaLog
• luaLog: (log: string) => void
Emitted when the client receives lua logs or errors from #Lua chat.
Type declaration
▸ (log): void
Parameters
| Name | Type |
|---|---|
log | string |
Returns
void
profile
• profile: (profile: Profile) => void
Emitted when data received from /profile
Type declaration
▸ (profile): void
Parameters
| Name | Type |
|---|---|
profile | Profile |
Returns
void
rawOldPacket
• rawOldPacket: (connection: Connection, ccc: number, data: string[]) => void
Emitted when a new old packet received.
Type declaration
▸ (connection, ccc, data): void
Parameters
| Name | Type |
|---|---|
connection | Connection |
ccc | number |
data | string[] |
Returns
void
rawPacket
• rawPacket: (conn: Connection, ccc: number, packet: ByteArray) => void
Emitted when a new packet received from main or bulle connection.
Type declaration
▸ (conn, ccc, packet): void
Parameters
| Name | Type |
|---|---|
conn | Connection |
ccc | number |
packet | ByteArray |
Returns
void
rawTribulle
• rawTribulle: (code: number, packet: ByteArray) => void
Emitted when a new community platform packet received.
Type declaration
▸ (code, packet): void
Parameters
| Name | Type |
|---|---|
code | number |
packet | ByteArray |
Returns
void
ready
• ready: () => void
Emitted when the client is fully ready to function.
Type declaration
▸ (): void
Returns
void
restart
• restart: () => void
Emitted when client is attempting to restart the connection
Type declaration
▸ (): void
Returns
void
roomChange
• roomChange: (after: Room, before: Room) => void
Emitted when the room is changed.
Example
client.on('roomChange', (after, before) => {
console.log('The room changed from '+before.name+' to '+after.name);
})
Type declaration
▸ (after, before): void
Parameters
| Name | Type |
|---|---|
after | Room |
before | Room |
Returns
void
roomMessage
• roomMessage: (message: RoomMessage) => void
Emitted when a player sends a message in the room.
Type declaration
▸ (message): void
Parameters
| Name | Type |
|---|---|
message | RoomMessage |
Returns
void
roomPassworded
• roomPassworded: (name: string) => void
Emitted when the room being attempted to enter needs a password.
Type declaration
▸ (name): void
Parameters
| Name | Type |
|---|---|
name | string |
Returns
void
roomPlayerDie
• roomPlayerDie: (player: RoomPlayer) => void
Emitted when a player dies
Type declaration
▸ (player): void
Parameters
| Name | Type |
|---|---|
player | RoomPlayer |
Returns
void
roomPlayerEnter
• roomPlayerEnter: (player: RoomPlayer) => void
Emitted when a new player entered the room.
Type declaration
▸ (player): void
Parameters
| Name | Type |
|---|---|
player | RoomPlayer |
Returns
void
roomPlayerEnterHole
• roomPlayerEnterHole: (player: RoomPlayer, order: number, time: number) => void
Emitted when a player enters the hole
Type declaration
▸ (player, order, time): void
Parameters
| Name | Type |
|---|---|
player | RoomPlayer |
order | number |
time | number |
Returns
void
roomPlayerGetCheese
• roomPlayerGetCheese: (player: RoomPlayer) => void
Emitted when a player get the cheese
Type declaration
▸ (player): void
Parameters
| Name | Type |
|---|---|
player | RoomPlayer |
Returns
void
roomPlayerLeave
• roomPlayerLeave: (player: Player) => void
Emitted when a player left the room.
Type declaration
▸ (player): void
Parameters
| Name | Type |
|---|---|
player | Player |
Returns
void
roomPlayerUpdate
• roomPlayerUpdate: (after: RoomPlayer, before: undefined | RoomPlayer) => void
Emitted when the room playerList is updated.
Type declaration
▸ (after, before): void
Parameters
| Name | Type |
|---|---|
after | RoomPlayer |
before | undefined | RoomPlayer |
Returns
void
roomPlayersUpdate
• roomPlayersUpdate: (after: RoomPlayer[], before: RoomPlayer[]) => void
Emitted when the room playerList is updated.
Type declaration
▸ (after, before): void
Parameters
| Name | Type |
|---|---|
after | RoomPlayer[] |
before | RoomPlayer[] |
Returns
void
tribe
• tribe: (tribe: null | Tribe) => void
Emitted when tribe information received
Type declaration
▸ (tribe): void
Parameters
| Name | Type |
|---|---|
tribe | null | Tribe |
Returns
void
tribeMemberConnect
• tribeMemberConnect: (name: string) => void
Emitted when a tribe member connected
Type declaration
▸ (name): void
Parameters
| Name | Type |
|---|---|
name | string |
Returns
void
tribeMemberDisconnect
• tribeMemberDisconnect: (name: string) => void
Emitted when a tribe member disconnected
Type declaration
▸ (name): void
Parameters
| Name | Type |
|---|---|
name | string |
Returns
void
tribeMemberUpdate
• tribeMemberUpdate: (member: Member) => void
Emitted when a tribe member updated
Type declaration
▸ (member): void
Parameters
| Name | Type |
|---|---|
member | Member |
Returns
void
tribeMessage
• tribeMessage: (message: TribulleMessage) => void
Emitted when a tribe message is received
Type declaration
▸ (message): void
Parameters
| Name | Type |
|---|---|
message | TribulleMessage |
Returns
void
tribulleConnect
• tribulleConnect: () => void
Emitted when the community platform (tribulle) is connected.
Type declaration
▸ (): void
Returns
void
whisper
• whisper: (message: WhisperMessage) => void
Emitted when a player sends a whisper message to the client.
Type declaration
▸ (message): void
Parameters
| Name | Type |
|---|---|
message | WhisperMessage |
Returns
void