Rez Free API

From CasperTech Wiki
Jump to: navigation, search
Stop icon.png Rez-Free Premium has been discontinued and is no longer available for purchase. Documentation remains to help people who already have the product.

Introduction

The Rez-Free PREMIUM is completely scriptable, and is compatible out of the box with any third party rezzing system which supports Lex Neva's "Rez Faux".

If you simply want to use this box in a rezzing system you bought from someone, you need to ask them how you can use Rez-Free or Rez-Faux boxes with their rezzer.

This API is a technical documentation which demonstrates how to communicate with the Rez-Free Premium, and is designed for people who already know how to write scripts.

Command Format

We accept API commands via linked message. The format is as follows:

llMessageLinked( LINK_THIS, COMMAND_NUMBER, CSV_LIST_OF_ARGUMENTS, MESSAGE_ID );

The COMMAND_NUMBER is one of the command number listed below.

The CSV_LIST_OF_ARGUMENTS is a comma seperated list of arguments corresponding with the commands below.

The MESSAGE_ID is a unique identifier string of your choice - it will be returned to you with the reply.

API Response Format

The response will arrive as a linked message, so there is no channel number required. The Integer parameter will contain a response code (listed below). The key parameter will contain your provided message ID. The string parameter will be empty unless a response string is needed.

API Events


The rez-free will send certain API messages when things happen.

REZ_FREE_EVENT_REZ - Sent when the build is finished rezzing
REZ_FREE_EVENT_DEREZ - Sent when the build has been de-rezzed or deleted
REZ_FREE_EVENT_SAVE - Sent when the build is frozen (scripts are removed)
REZ_FREE_EVENT_STORE - Sent when the positions are stored
REZ_FREE_EVENT_LET_ME_SELL - Sent when the build is finalised

Command List


Here is a list of commands.

Command number: REZ_FREE_COMMAND_REZ
Description: This instructs the Rez-Free to rez the current build.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS ...or... REZ_FREE_RESPONSE_ALREADY_REZZED
Command number: REZ_FREE_COMMAND_DEREZ
Description: This instructs the Rez-Free to DeRez the current build.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS ...or... REZ_FREE_RESPONSE_NOT_REZZED
Command number: REZ_FREE_COMMAND_SAVE
Description: This instructs the Rez-Free to remove all scripts from the build ("Freeze" it)
Possible response codes: REZ_FREE_RESPONSE_SUCCESS ...or... REZ_FREE_RESPONSE_NOT_REZZED
Command number: REZ_FREE_COMMAND_STORE
Description: This instructs the Rez-Free store the positions of the various parts in the description field of the objects.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS ...or... REZ_FREE_RESPONSE_NOT_REZZED
Command number: REZ_FREE_COMMAND_LET_ME_SELL
Description: This instructs the Rez-Free to "Finalise" the build and make it transferrable.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS
Command number: REZ_FREE_COMMAND_QUERY_BUILD
Description: This simply "pings" the box to see if it supports our API.
Possible response codes: REZ_FREE_RESPONSE_BUILD
Command number: REZ_FREE_COMMAND_QUERY_TRANSFERABLE
Description: This asks the rezzer if it's transferrable
Possible response codes: REZ_FREE_RESPONSE_NOT_TRANSFERABLE ...or... REZ_FREE_RESPONSE_TRANSFERABLE
Command number: REZ_FREE_COMMAND_QUERY_REZZED
Description: This asks the rezzer if it's currently rezzed
Possible response codes: REZ_FREE_RESPONSE_ALREADY_REZZED ...or... REZ_FREE_RESPONSE_NOT_REZZED
Command number: REZ_FREE_COMMAND_QUERY_VERSION
Description: This gets the rezzer's compatible Rez-Faux API version
Possible response codes: REZ_FREE_RESPONSE_VERSION (string will be the version number, currently 2.0)
Command number: REZ_FREE_COMMAND_SET_DIALOG_ON_REZ
Description: This tells the rezzer whether to show a dialog on rez or not. If the string == 1 then the dialog will be shown, otherwise, it won't.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS
Command number: REZ_FREE_COMMAND_SET_DIALOG
Description: This tells the rezzer whether it accepts "touches" to get the dialog or not. If string == 1 then the dialog will be shown, otherwise, it won't.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS
Command number: REZ_FREE_COMMAND_TRACK_MOVEMENT
Description: This tells the rezzer whether the rezzed parts should track the anchor when the anchor is moved. string of "1" == yes, otherwise no.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS
Command number: REZ_FREE_COMMAND_FORCE_UPDATE
Description: This forces the unit to send out a position update to the tracking objects.
Possible response codes: REZ_FREE_RESPONSE_SUCCESS

Constants


integer REZ_FREE_COMMAND_REZ = 0x23000;
integer REZ_FREE_COMMAND_DEREZ = 0x23001;
integer REZ_FREE_COMMAND_SAVE = 0x23002;
integer REZ_FREE_COMMAND_STORE = 0x23003;
integer REZ_FREE_COMMAND_LET_ME_SELL = 0x23004;
integer REZ_FREE_COMMAND_QUERY_BUILD = 0x23010;
integer REZ_FREE_COMMAND_QUERY_TRANSFERABLE = 0x23011;
integer REZ_FREE_COMMAND_QUERY_REZZED = 0x23012;
integer REZ_FREE_COMMAND_SET_DIALOG_ON_REZ = 0x23013;
integer REZ_FREE_COMMAND_SET_DIALOG = 0x23025;
integer REZ_FREE_COMMAND_QUERY_VERSION = 0x23026;
integer REZ_FREE_COMMAND_TRACK_MOVEMENT = 0x23080;
integer REZ_FREE_COMMAND_FORCE_UPDATE = 0x23081;
integer REZ_FREE_RESPONSE_SUCCESS = 0x23100;
integer REZ_FREE_RESPONSE_FAILURE = 0x23101;
integer REZ_FREE_RESPONSE_NO_BUILD = 0x23102;
integer REZ_FREE_RESPONSE_ALREADY_SELLABLE = 0x23103;
integer REZ_FREE_RESPONSE_NOT_REZZED = 0x23104;
integer REZ_FREE_RESPONSE_ALREADY_REZZED = 0x23106;
integer REZ_FREE_RESPONSE_BUILD = 0x23108;
integer REZ_FREE_RESPONSE_TRANSFERABLE = 0x23109;
integer REZ_FREE_RESPONSE_NOT_TRANSFERABLE = 0x23109;
integer REZ_FREE_RESPONSE_VERSION = 0x23110;
integer REZ_FREE_EVENT_REZ = 0x23200;
integer REZ_FREE_EVENT_DEREZ = 0x23201;
integer REZ_FREE_EVENT_SAVE = 0x23202;
integer REZ_FREE_EVENT_STORE = 0x23203;
integer REZ_FREE_EVENT_LET_ME_SELL = 0x23204;