EventSinkApiDeclaration
Properties
Section titled “Properties”No properties found.
No fields found.
No enums found.
Methods
Section titled “Methods”OnItemCreated
Section titled “OnItemCreated”(callback)
Invoked when an item is added to the client.
The event’s argument is the ApiItem.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnItemUpdated
Section titled “OnItemUpdated”(callback)
Invoked when an item is already in the client but has been updated.
The event’s argument is the ApiItem.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnCorpseCreated
Section titled “OnCorpseCreated”(callback)
Invoked when a corpse is added to the client. The event’s ‘sender’ is the corpse Item
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnConnected
Section titled “OnConnected”(callback)
Invoked when the player is connected to a server
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnDisconnected
Section titled “OnDisconnected”(callback)
Invoked when the player is disconnected from the server
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
MessageReceived
Section titled “MessageReceived”(callback)
Invoked when any message is received from the server after client processing
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
RawMessageReceived
Section titled “RawMessageReceived”(callback)
Invoked when any message is received from the server before client processing
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
ClilocMessageReceived
Section titled “ClilocMessageReceived”(callback)
Not currently used. May be removed later or put into use, not sure right now
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
JournalEntryAdded
Section titled “JournalEntryAdded”(callback)
Invoked when a message is added to the journal
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
SoundPlayed
Section titled “SoundPlayed”(callback)
Invoked when the server requests that a sound be played
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OPLOnReceive
Section titled “OPLOnReceive”(callback)
Invoked when an object’s property list data (Tooltip text for items) is received
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnBuffAdded
Section titled “OnBuffAdded”(callback)
Invoked when a buff is “added” to a player.
The event’s argument is the ApiBuff.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnBuffRemoved
Section titled “OnBuffRemoved”(callback)
Invoked when a buff is “removed” to a player (Called before removal)
The event’s argument is the ApiBuff.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnPositionChanged
Section titled “OnPositionChanged”(callback)
Invoked when the player’s position is changed
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnEntityDamage
Section titled “OnEntityDamage”(callback)
Invoked when any entity in the game receives damage, not necessarily the player.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnOpenContainer
Section titled “OnOpenContainer”(callback)
Invoked when a container is opened.
The event’s ‘sender’ is the Item, the event’s argument is the item’s serial
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnPlayerDeath
Section titled “OnPlayerDeath”(callback)
Invoked when the player receives a death packet from the server
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnPathFinding
Section titled “OnPathFinding”(callback)
Invoked when the player or server tells the client to path find
Vector is X, Y, Z, and Distance
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnSetWeather
Section titled “OnSetWeather”(callback)
Invoked when the server asks the client to generate some weather
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
OnPlayerHitsChanged
Section titled “OnPlayerHitsChanged”(callback)
Invoked after the player’s hit points have changed.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)
ApiMobileCreated
Section titled “ApiMobileCreated”(callback)
Invoked when a mobile is created.
The event’s sender is null and the argument is an ApiMobile.
Parameters:
| Name | Type | Optional | Description |
|---|---|---|---|
callback | object | ❌ No |
Return Type: void (Does not return anything)