mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2025-12-12 10:42:37 +00:00
d1ccb530b2
## About The Pull Request Ever since byondapi went stable, I've been meaning to create a replacement lua library that uses it instead of the auxtools-based auxlua. After so many months, I've finally got the code just about into a position where it's ready for a PR. [Click here](https://hackmd.io/@aloZJicNQrmfYgykhfFwAQ/BySAS18u0) for a guide to rewriting auxlua scripts for dreamluau syntax. ## Why It's Good For The Game Code that runs on production servers should not depend on memory hacks that are liable to break any time Dream Daemon updates. ## Changelog 🆑 admin: Admin lua scripting uses a new library that (probably) will not break when BYOND updates. /🆑 ## TODO: - [x] Convert the lua editor ui to TS - [x] Include a guide for converting scripts from auxlua syntax to dreamluau syntax
240 lines
8.8 KiB
Plaintext
240 lines
8.8 KiB
Plaintext
/datum
|
|
var/__auxtools_weakref_id //used by auxtools for weak references
|
|
|
|
/**
|
|
* Sets a global proc to call in place of just outright setting a datum's var to a given value
|
|
*
|
|
* The proc will be called with the arguments (datum/datum_to_modify, var_name, value)
|
|
*
|
|
* required wrapper text the name of the proc to use as the wrapper
|
|
*/
|
|
/proc/__lua_set_set_var_wrapper(wrapper)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Sets a global proc to call in place of just outright calling a given proc on a datum
|
|
*
|
|
* The proc will be called with the arguments (datum/thing_to_call, proc_to_call, list/arguments)
|
|
*
|
|
* required wrapper text the name of the proc to use as the wrapper
|
|
*/
|
|
/proc/__lua_set_datum_proc_call_wrapper(wrapper)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Sets a global proc to call in place of just outright calling a given global proc
|
|
*
|
|
* The proc will be called with the arguments (proc_to_call, list/arguments)
|
|
*
|
|
* required wrapper text the name of the proc to use as the wrapper
|
|
*/
|
|
/proc/__lua_set_global_proc_call_wrapper(wrapper)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Sets a global proc as a wrapper for lua's print function
|
|
*
|
|
* The proc will be called with the arguments (state_id, list/arguments)
|
|
*
|
|
* required wrapper text the name of the proc to use as the wrapper
|
|
*/
|
|
/proc/__lua_set_print_wrapper(wrapper)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Sets the maximum amount of time a lua chunk or function can execute without sleeping or yielding.
|
|
* Chunks/functions that exceed this duration will produce an error.
|
|
*
|
|
* required limit number the execution limit, in milliseconds
|
|
*/
|
|
/proc/__lua_set_execution_limit(limit)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Creates a new lua state.
|
|
*
|
|
* return text a pointer to the created state.
|
|
*/
|
|
/proc/__lua_new_state()
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Loads a chunk of lua source code and executes it
|
|
*
|
|
* required state text a pointer to the state
|
|
* in which to execute the code
|
|
* required script text the lua source code to execute
|
|
* optional name text a name to give to the chunk
|
|
*
|
|
* return list|text a list of lua return information
|
|
* or an error message if the state was corrupted
|
|
*
|
|
* Lua return information is formatted as followed:
|
|
* - ["status"]: How the chunk or function stopped code execution
|
|
* - "sleeping": The chunk or function called dm.sleep,
|
|
* placing it in the sleep queue. Items in the sleep
|
|
* queue can be resumed using /proc/__lua_awaken
|
|
* - "yielded": The chunk or function called coroutine.yield,
|
|
* placing it in the yield table. Items in the yield
|
|
* table can can be resumed by passing their index
|
|
* to /proc/__lua_resume
|
|
* - "finished": The chunk or function finished
|
|
* - "errored": The chunk or function produced an error
|
|
* - "bad return": The chunk or function yielded or finished,
|
|
* but its return value could not be converted to DM values
|
|
* - ["param"]: Depends on status.
|
|
* - "sleeping": null
|
|
* - "yielded" or "finished": The return/yield value(s)
|
|
* - "errored" or "bad return": The error message
|
|
* - ["yield_index"]: The index in the yield table where the
|
|
* chunk or function is located, for calls to __lua_resume
|
|
* - ["name"]: The name of the chunk or function, for logging
|
|
*/
|
|
/proc/__lua_load(state, script, name)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Calls a lua function
|
|
*
|
|
* required state text a pointer to the state
|
|
* in which to call the function
|
|
* required function text the name of the function to call
|
|
* optional arguments list arguments to pass to the function
|
|
*
|
|
* return list|text a list of lua return information
|
|
* or an error message if the state was corrupted
|
|
*
|
|
* Lua return information is formatted as followed:
|
|
* - ["status"]: How the chunk or function stopped code execution
|
|
* - "sleeping": The chunk or function called dm.sleep,
|
|
* placing it in the sleep queue. Items in the sleep
|
|
* queue can be resumed using /proc/__lua_awaken
|
|
* - "yielded": The chunk or function called coroutine.yield,
|
|
* placing it in the yield table. Items in the yield
|
|
* table can can be resumed by passing their index
|
|
* to /proc/__lua_resume
|
|
* - "finished": The chunk or function finished
|
|
* - "errored": The chunk or function produced an error
|
|
* - "bad return": The chunk or function yielded or finished,
|
|
* but its return value could not be converted to DM values
|
|
* - ["param"]: Depends on status.
|
|
* - "sleeping": null
|
|
* - "yielded" or "finished": The return/yield value(s)
|
|
* - "errored" or "bad return": The error message
|
|
* - ["yield_index"]: The index in the yield table where the
|
|
* chunk or function is located, for calls to __lua_resume
|
|
* - ["name"]: The name of the chunk or function, for logging
|
|
*/
|
|
/proc/__lua_call(state, function, arguments)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Dequeues the task at the front of the sleep queue and resumes it
|
|
*
|
|
* required state text a pointer to the state in which
|
|
* to resume a task
|
|
*
|
|
* return list|text|null a list of lua return information,
|
|
* an error message if the state is corrupted,
|
|
* or null if the sleep queue is empty
|
|
*
|
|
* Lua return information is formatted as followed:
|
|
* - ["status"]: How the chunk or function stopped code execution
|
|
* - "sleeping": The chunk or function called dm.sleep,
|
|
* placing it in the sleep queue. Items in the sleep
|
|
* queue can be resumed using /proc/__lua_awaken
|
|
* - "yielded": The chunk or function called coroutine.yield,
|
|
* placing it in the yield table. Items in the yield
|
|
* table can can be resumed by passing their index
|
|
* to /proc/__lua_resume
|
|
* - "finished": The chunk or function finished
|
|
* - "errored": The chunk or function produced an error
|
|
* - "bad return": The chunk or function yielded or finished,
|
|
* but its return value could not be converted to DM values
|
|
* - ["param"]: Depends on status.
|
|
* - "sleeping": null
|
|
* - "yielded" or "finished": The return/yield value(s)
|
|
* - "errored" or "bad return": The error message
|
|
* - ["yield_index"]: The index in the yield table where the
|
|
* chunk or function is located, for calls to __lua_resume
|
|
* - ["name"]: The name of the chunk or function, for logging
|
|
*/
|
|
/proc/__lua_awaken(state)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Removes the task at the specified index from the yield table
|
|
* and resumes it
|
|
*
|
|
* required state text a pointer to the state in which to
|
|
* resume a task
|
|
* required index number the index in the yield table of the
|
|
* task to resume
|
|
* optional arguments list the arguments to resume the task with
|
|
*
|
|
* return list|text|null a list of lua return information,
|
|
* an error message if the state is corrupted,
|
|
* or null if there is no task at the specified index
|
|
*
|
|
* Lua return information is formatted as followed:
|
|
* - ["status"]: How the chunk or function stopped code execution
|
|
* - "sleeping": The chunk or function called dm.sleep,
|
|
* placing it in the sleep queue. Items in the sleep
|
|
* queue can be resumed using /proc/__lua_awaken
|
|
* - "yielded": The chunk or function called coroutine.yield,
|
|
* placing it in the yield table. Items in the yield
|
|
* table can can be resumed by passing their index
|
|
* to /proc/__lua_resume
|
|
* - "finished": The chunk or function finished
|
|
* - "errored": The chunk or function produced an error
|
|
* - "bad return": The chunk or function yielded or finished,
|
|
* but its return value could not be converted to DM values
|
|
* - ["param"]: Depends on status.
|
|
* - "sleeping": null
|
|
* - "yielded" or "finished": The return/yield value(s)
|
|
* - "errored" or "bad return": The error message
|
|
* - ["yield_index"]: The index in the yield table where the
|
|
* chunk or function is located, for calls to __lua_resume
|
|
* - ["name"]: The name of the chunk or function, for logging
|
|
*/
|
|
/proc/__lua_resume(state, index, arguments)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Get the variables within a state's environment.
|
|
* Values not convertible to DM values are substituted
|
|
* for their types as text
|
|
*
|
|
* required state text a pointer to the state
|
|
* to get the variables from
|
|
*
|
|
* return list the variables of the state's environment
|
|
*/
|
|
/proc/__lua_get_globals(state)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Get a list of all tasks currently in progress within a state
|
|
*
|
|
* required state text a pointer to the state
|
|
* to get the tasks from
|
|
*
|
|
* return list a list of the state's tasks, formatted as follows:
|
|
* - name: The name of the task
|
|
* - status: Whether the task is sleeping or yielding
|
|
* - index: The index of the task in the sleep queue
|
|
* or yield table, whichever is applicable
|
|
*/
|
|
/proc/__lua_get_tasks(state)
|
|
CRASH("auxlua not loaded")
|
|
|
|
/**
|
|
* Kills a task in progress
|
|
*
|
|
* required state text a pointer to the state
|
|
* in which to kill a task
|
|
* required info list the task info
|
|
*/
|
|
/proc/__lua_kill_task(state, info)
|
|
CRASH("auxlua not loaded")
|