IdlePixel+ Custom Handling

Library for parsing custom messages.

This script should not be not be installed directly. It is a library for other scripts to include with the meta directive // @require https://update.greasyfork.org/scripts/484046/1307197/IdlePixel%2B%20Custom%20Handling.js

Ask a question, post a review, or report the script.

Author: Lux-Ferre
Version: 1.0.0
Created: 2024-01-06
Updated: 2024-01-06
Size: 1.45 KB
License: MIT

Idle-Pixel Custom Handling Framework Plugin

Extension to IP+ that adds static methods for handling custom websocket messages. It is designed to make using customs in the Anwin Custom Standard format easier.

The ACS format is: CUSTOM=recipient:callbackId:plugin:command:payload

Parser

Customs.parseCustom(player, content, callbackId)

Returns a single object of the form:

{
    player: player,
    callbackId: callbackId,
    anwinFormatted: true,
    plugin: plugin,
    command: command, 
    payload: payload
}

Note: If message is not in the ACS format, the returned object will be of the form:

{
    player: player,
    callbackId: callbackId,
    anwinFormatted: false,
    plugin: "unknown",
    command: "unknown", 
    payload: content
}

Sender

Customs.sendBasicCustom(recipient, plugin, command, payload)

This method will create an IP+ custom object and pass it on to IdlePixelPlus.sendCustomMessage()

If the advanced features of IdlePixelPlus.sendCustomMessage() are needed (ie callback functions), that method will have to be called directly instead.

扫码关注【爱吃馍】

Idle-Pixel Custom Handling Framework Plugin

Parser

Sender