Luau Scripting in Substrata

--lua

print("hello")

Called when a user's avatar touches an object. If an avatar continues to touch an object, for example the avatar is standing on an object, this event will continue to be fired at a regular period of something like 0.5 s.

Called when a user uses an object. Currently users use objects by moving the mouse cursor over an object and pressing the E key.

Called when a user avatar moves near (within a certain distance) to an object. The distance is currently 20 metres.

Called when a user avatar moves away from (further than a certain distance) an object. The distance is currently 20 metres.

Called when a user avatar enters the land parcel that the script object is inside.

Called when a user avatar exits the land parcel that the script object is inside.

Called when a user avatar enters (or sits on in the case of a bike) a vehicle.

Called when a user avatar exits a vehicle.

Returns the object that has the given UID. Throws exception if no such object exists.

Shows a string message on the screen of the user of the given avatar. The message will be displayed for a few seconds.

Creates a timer, when the timer interval is complete, onTimerEvent is called. onTimerEvent should be a function with the following signature:

onTimerEvent(object : Object)

Throws an exception if more than 4 timer events are created without being destroyed.

Returns a timer handle that can be passed to destroyTimer.

Destroys a timer. Has no effect if the timer has already completed (for non-repeating timers), or has already been destroyed.

Adds a listener for an event on another object.

For example, this code listens for the touch event on the object with UID 583:

addEventListener("onUserTouchedObject", 583, onUserTouchedObject)

{
  response_code: number
  response_message : string
  mime_type : string
  body_data : buffer
}

{
  error_code : number
  error_description : string
}

ErrorCode_OK = 0,
ErrorCode_Other = 1,
ErrorCode_RateLimited = 2

Sends an HTTP request to a server.

Requests are rate-limited: a maximum of 5 requests per 300 seconds are allowed per user. Exceeding this rate will result in onError being called with error_code = 2 (ErrorCode_RateLimited).

For example:

function onDone(result)
	print("response_code: " .. tostring(result.response_code))
	print("response_message: " .. result.response_message)
	print("mime_type: " .. result.mime_type)
	print("body_data: " .. result.body_data)
end

function onError(result)
	print("error_code: " .. tostring(result.error_code))
	print("error_description: " .. result.error_description)
end

doHTTPGetRequestAsync(
	"https://coolwebsite.com/someapi?id=dfdfsdf", -- URL
	{ Authorization = "Basic afsdefsdfd" } -- additional_header_lines
	onDone, onError
)

{
  response_code: number
  response_message : string
  mime_type : string
  body_data : buffer
}

{
  error_code : number
  error_description : string
}

ErrorCode_OK = 0,
ErrorCode_Other = 1,
ErrorCode_RateLimited = 2

Sends an HTTP post request to a server.

Requests are rate-limited: a maximum of 5 requests per 300 seconds are allowed per user. Exceeding this rate will result in onError being called with error_code = 2 (ErrorCode_RateLimited).

For example:

function onDone(result)
	print("response_code: " .. tostring(result.response_code))
	print("response_message: " .. result.response_message)
	print("mime_type: " .. result.mime_type)
	print("body_data: " .. result.body_data)
end

function onError(result)
	print("error_code: " .. tostring(result.error_code))
	print("error_description: " .. result.error_description)
end

doHTTPPostRequestAsync(
	"https://coolwebsite.com/someapi?id=dfdfsdf", -- URL
	"{ id : \"123\" }", -- post content
	"application/json", -- content type
	{ Authorization = "Basic afsdefsdfd" } -- additional_header_lines
	onDone, onError
)

Get a secret string that has been set via the Account Secrets page (/secrets). This is useful for retrieving things like API keys that you want to use in a script, but don't want other users to see.

my_api_key = getSecret("MY_API_KEY")

Parse a JSON string and convert it to the equivalent Lua object.

JSON objects and arrays are converted to Lua tables. JSON null is converted to Lua nil.

parseJSON('[123.456, true, \"abc\", null]') 
-- returns the Lua array table {123.456, true, "abc", nil}

Store a value in object storage. These values are persistently stored, and remain stored even over server restarts or script reloads and changes, unlike variables in Lua scripts.

Overwrites any existing values with the given key and script object.

For example, here is how you could store a visitor counter in object storage:

objectstorage.setItem("num_visits", new_num_visits)

Retrieves a value from object storage. Returns nil if there is no such item stored.

num_visits = objectstorage.getItem("num_visits")