Messages
Do not clutter up the Socket class with callbacks, have this class here until a better method arises in my head.
This class should not have any complex functionality, its main role is to provide organization for packets and increase readability
Please respect the order of the Packets Enum and arrange functions accordingly.
Constructor Summary
Public Constructor | ||
public |
|
Member Summary
Public Members | ||
public |
|
|
public |
|
|
public |
|
|
public |
bankCallback: * |
|
public |
|
|
public |
chatCallback: * |
|
public |
client: * |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
healCallback: * |
|
public |
|
|
public |
messages: *[] |
|
public |
|
|
public |
|
|
public |
|
|
public |
npcCallback: * |
|
public |
|
|
public |
|
|
public |
|
|
public |
|
|
public |
pvpCallback: * |
|
public |
|
|
public |
|
|
public |
shopCallback: * |
|
public |
|
|
public |
syncCallback: * |
|
public |
|
|
public |
|
Method Summary
Public Methods | ||
public |
handleBulkData(data: Array[String]) Handle bulk data messages, calls handleData() on each one in the array |
|
public |
handleData(data: String) Handle a message from the server |
|
public |
handleUTF8(message: String) Handle a UTF8 message, not a server packet message Displays the error message on the client |
|
public |
Universal callback for onAbility |
|
public |
onAnimation(callback: Function) Universal callback for onAnimation |
|
public |
Universal callback for onAudio |
|
public |
Universal callback for onBank |
|
public |
Universal callback for onBlink |
|
public |
Universal callback for onChat |
|
public |
Universal callback for onCombat |
|
public |
Universal callback for onCommand |
|
public |
Universal callback for onDeath |
|
public |
Universal callback for onDespawn |
|
public |
Universal callback for onEnchant |
|
public |
onEntityList(callback: Function) Universal callback for onEntityList |
|
public |
onEquipment(callback: Function) Universal callback for onEquipment |
|
public |
onExperience(callback: Function) Universal callback for onExperience |
|
public |
Universal callback for onGuild |
|
public |
onHandshake(callback: Function) Universal callback for onHandshake |
|
public |
Universal callback for onHeal |
|
public |
onInventory(callback: Function) Universal callback for onInventory |
|
public |
onMovement(callback: Function) Universal callback for onMovement |
|
public |
Universal callback for onNPC |
|
public |
Universal callback for onNetwork |
|
public |
onNotification(callback: Function) Universal callback for onNotification |
|
public |
Universal callback for onPVP |
|
public |
Universal callback for onPointer |
|
public |
Universal callback for onPoints |
|
public |
onPopulation(callback: Function) Universal callback for onPopulation |
|
public |
onProjectile(callback: Function) Universal callback for onProjectile |
|
public |
Universal callback for onQuest |
|
public |
Universal callback for onRespawn |
|
public |
Universal callback for onShop |
|
public |
Universal callback for onSpawn |
|
public |
Universal callback for onSync |
|
public |
onTeleport(callback: Function) Universal callback for onTeleport |
|
public |
Universal callback for onWelcome |
|
public |
receiveAbility(data: String) Recieve the server ability |
|
public |
receiveAnimation(data: String) Recieve the server animation |
|
public |
receiveAudio(data: String) Recieve the server audio |
|
public |
receiveBank(data: String) Recieve the server bank callback |
|
public |
receiveBlink(data: String) Recieve the server blink |
|
public |
receiveChat(data: String) Recieve the server chat message |
|
public |
receiveCombat(data: String) Recieve the server combat |
|
public |
receiveCommand(data: String) Recieve the server command |
|
public |
receiveDeath(data: String) Recieve the server death |
|
public |
receiveDespawn(data: String) Recieve the server despawn |
|
public |
receiveEnchant(data: String) Recieve the server enchant |
|
public |
receiveEntityList(data: String) Recieve the server list of game entities |
|
public |
receiveEquipment(data: String) Recieve equipment change |
|
public |
receiveExperience(data: String) Recieve the server experience |
|
public |
receiveGuild(data: String) Recieve the server guild |
|
public |
receiveHandshake(data: String) Recieve the server handshake |
|
public |
receiveHeal(data: String) Recieve the server heal |
|
public |
receiveInventory(data: String) Recieve the server inventory |
|
public |
receiveMovement(data: String) Recieve the server entity movement |
|
public |
receiveNPC(data: String) Recieve the server NPC |
|
public |
receiveNetwork(data: String) Recieve the server network change |
|
public |
receiveNotification(data: String) Recieve the server notification |
|
public |
receivePVP(data: String) Recieve the server player vs player (PVP) |
|
public |
receivePointer(data: String) Recieve the server pointer |
|
public |
receivePoints(data: String) Recieve the server points |
|
public |
receivePopulation(data: String) Recieve the server population |
|
public |
receiveProjectile(data: String) Recieve the server projectile |
|
public |
receiveQuest(data: String) Recieve the server quest |
|
public |
receiveRespawn(data: String) Recieve the server respawn |
|
public |
receiveShop(data: String) Recieve the server shop |
|
public |
receiveSpawn(data: String) Recieve server spawn |
|
public |
receiveSync(data: String) Recieve the server sync |
|
public |
receiveTeleport(data: String) Recieve the server teleport |
|
public |
receiveWelcome(data: String) Recieve the server welcome |
Public Constructors
public constructor() source
Public Members
public abilityCallback: * source
public animationCallback: * source
public audioCallback: * source
public bankCallback: * source
public blinkCallback: * source
public chatCallback: * source
public client: * source
public combatCallback: * source
public commandCallback: * source
public deathCallback: * source
public despawnCallback: * source
public enchantCallback: * source
public entityListCallback: * source
public equipmentCallback: * source
public experienceCallback: * source
public guildCallback: * source
public handshakeCallback: * source
public healCallback: * source
public inventoryCallback: * source
public messages: *[] source
public movementCallback: * source
public networkCallback: * source
public notificationCallback: * source
public npcCallback: * source
public pointerCallback: * source
public pointsCallback: * source
public populationCallback: * source
public projectileCallback: * source
public pvpCallback: * source
public questCallback: * source
public respawnCallback: * source
public shopCallback: * source
public spawnCallback: * source
public syncCallback: * source
public teleportCallback: * source
public welcomeCallback: * source
Public Methods
public handleBulkData(data: Array[String]) source
Handle bulk data messages, calls handleData() on each one in the array
Params:
Name | Type | Attribute | Description |
data | Array[String] | Handle a list of messages |
public handleData(data: String) source
Handle a message from the server
Params:
Name | Type | Attribute | Description |
data | String | the packet number and data |
public handleUTF8(message: String) source
Handle a UTF8 message, not a server packet message Displays the error message on the client
Params:
Name | Type | Attribute | Description |
message | String | the message |
public onAbility(callback: Function) source
Universal callback for onAbility
Params:
Name | Type | Attribute | Description |
callback | Function |
public onAnimation(callback: Function) source
Universal callback for onAnimation
Params:
Name | Type | Attribute | Description |
callback | Function |
public onAudio(callback: Function) source
Universal callback for onAudio
Params:
Name | Type | Attribute | Description |
callback | Function |
public onBank(callback: Function) source
Universal callback for onBank
Params:
Name | Type | Attribute | Description |
callback | Function |
public onBlink(callback: Function) source
Universal callback for onBlink
Params:
Name | Type | Attribute | Description |
callback | Function |
public onChat(callback: Function) source
Universal callback for onChat
Params:
Name | Type | Attribute | Description |
callback | Function |
public onCombat(callback: Function) source
Universal callback for onCombat
Params:
Name | Type | Attribute | Description |
callback | Function |
public onCommand(callback: Function) source
Universal callback for onCommand
Params:
Name | Type | Attribute | Description |
callback | Function |
public onDeath(callback: Function) source
Universal callback for onDeath
Params:
Name | Type | Attribute | Description |
callback | Function |
public onDespawn(callback: Function) source
Universal callback for onDespawn
Params:
Name | Type | Attribute | Description |
callback | Function |
public onEnchant(callback: Function) source
Universal callback for onEnchant
Params:
Name | Type | Attribute | Description |
callback | Function |
public onEntityList(callback: Function) source
Universal callback for onEntityList
Params:
Name | Type | Attribute | Description |
callback | Function |
public onEquipment(callback: Function) source
Universal callback for onEquipment
Params:
Name | Type | Attribute | Description |
callback | Function |
public onExperience(callback: Function) source
Universal callback for onExperience
Params:
Name | Type | Attribute | Description |
callback | Function |
public onGuild(callback: Function) source
Universal callback for onGuild
Params:
Name | Type | Attribute | Description |
callback | Function |
public onHandshake(callback: Function) source
Universal callback for onHandshake
Params:
Name | Type | Attribute | Description |
callback | Function |
public onHeal(callback: Function) source
Universal callback for onHeal
Params:
Name | Type | Attribute | Description |
callback | Function |
public onInventory(callback: Function) source
Universal callback for onInventory
Params:
Name | Type | Attribute | Description |
callback | Function |
public onMovement(callback: Function) source
Universal callback for onMovement
Params:
Name | Type | Attribute | Description |
callback | Function |
public onNPC(callback: Function) source
Universal callback for onNPC
Params:
Name | Type | Attribute | Description |
callback | Function |
public onNetwork(callback: Function) source
Universal callback for onNetwork
Params:
Name | Type | Attribute | Description |
callback | Function |
public onNotification(callback: Function) source
Universal callback for onNotification
Params:
Name | Type | Attribute | Description |
callback | Function |
public onPVP(callback: Function) source
Universal callback for onPVP
Params:
Name | Type | Attribute | Description |
callback | Function |
public onPointer(callback: Function) source
Universal callback for onPointer
Params:
Name | Type | Attribute | Description |
callback | Function |
public onPoints(callback: Function) source
Universal callback for onPoints
Params:
Name | Type | Attribute | Description |
callback | Function |
public onPopulation(callback: Function) source
Universal callback for onPopulation
Params:
Name | Type | Attribute | Description |
callback | Function |
public onProjectile(callback: Function) source
Universal callback for onProjectile
Params:
Name | Type | Attribute | Description |
callback | Function |
public onQuest(callback: Function) source
Universal callback for onQuest
Params:
Name | Type | Attribute | Description |
callback | Function |
public onRespawn(callback: Function) source
Universal callback for onRespawn
Params:
Name | Type | Attribute | Description |
callback | Function |
public onShop(callback: Function) source
Universal callback for onShop
Params:
Name | Type | Attribute | Description |
callback | Function |
public onSpawn(callback: Function) source
Universal callback for onSpawn
Params:
Name | Type | Attribute | Description |
callback | Function |
public onSync(callback: Function) source
Universal callback for onSync
Params:
Name | Type | Attribute | Description |
callback | Function |
public onTeleport(callback: Function) source
Universal callback for onTeleport
Params:
Name | Type | Attribute | Description |
callback | Function |
public onWelcome(callback: Function) source
Universal callback for onWelcome
Params:
Name | Type | Attribute | Description |
callback | Function |
public receiveAbility(data: String) source
Recieve the server ability
Params:
Name | Type | Attribute | Description |
data | String | Packet, opcode and info message |
public receiveAnimation(data: String) source
Recieve the server animation
Params:
Name | Type | Attribute | Description |
data | String | Packet, id and info |
public receiveAudio(data: String) source
Recieve the server audio
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveBank(data: String) source
Recieve the server bank callback
Params:
Name | Type | Attribute | Description |
data | String | Packet, opcode and info message |
public receiveBlink(data: String) source
Recieve the server blink
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveChat(data: String) source
Recieve the server chat message
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveCombat(data: String) source
Recieve the server combat
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveCommand(data: String) source
Recieve the server command
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveDeath(data: String) source
Recieve the server death
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveDespawn(data: String) source
Recieve the server despawn
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveEnchant(data: String) source
Recieve the server enchant
Params:
Name | Type | Attribute | Description |
data | String | Opcode and info message |
public receiveEntityList(data: String) source
Recieve the server list of game entities
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveEquipment(data: String) source
Recieve equipment change
Params:
Name | Type | Attribute | Description |
data | String | Packet, equipment type, and equipment info message |
public receiveExperience(data: String) source
Recieve the server experience
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveGuild(data: String) source
Recieve the server guild
Params:
Name | Type | Attribute | Description |
data | String | Opcode and info message |
public receiveHandshake(data: String) source
Recieve the server handshake
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveHeal(data: String) source
Recieve the server heal
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveInventory(data: String) source
Recieve the server inventory
Params:
Name | Type | Attribute | Description |
data | String | Packet, opcode and data message |
public receiveMovement(data: String) source
Recieve the server entity movement
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveNPC(data: String) source
Recieve the server NPC
Params:
Name | Type | Attribute | Description |
data | String | Opcode and info message |
public receiveNetwork(data: String) source
Recieve the server network change
Params:
Name | Type | Attribute | Description |
data | String | Packet and opcode data message |
public receiveNotification(data: String) source
Recieve the server notification
Params:
Name | Type | Attribute | Description |
data | String | Packet, opcode and message |
public receivePVP(data: String) source
Recieve the server player vs player (PVP)
Params:
Name | Type | Attribute | Description |
data | String | id and PVP id |
public receivePointer(data: String) source
Recieve the server pointer
Params:
Name | Type | Attribute | Description |
data | String | Opcode and info message |
public receivePoints(data: String) source
Recieve the server points
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receivePopulation(data: String) source
Recieve the server population
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveProjectile(data: String) source
Recieve the server projectile
Params:
Name | Type | Attribute | Description |
data | String | Packet, type and info |
public receiveQuest(data: String) source
Recieve the server quest
Params:
Name | Type | Attribute | Description |
data | String | Packet, opcode and info message |
public receiveRespawn(data: String) source
Recieve the server respawn
Params:
Name | Type | Attribute | Description |
data | String | id, x, and y coordinates |
public receiveShop(data: String) source
Recieve the server shop
Params:
Name | Type | Attribute | Description |
data | String | Opcode and info message |
public receiveSpawn(data: String) source
Recieve server spawn
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |
public receiveSync(data: String) source
Recieve the server sync
Params:
Name | Type | Attribute | Description |
data | String | Packet and data message |