EXOL module documentation

Creates an actor communication channel.

Looks up an actor communication channel.

Enumerates actor objects.

Provides an inventory of actor-associated threads.

Identifies a parallel execution context.

Represents execution associated with an actor context.

Represents execution associated with a thread context.

Shift right while preserving the sign bit of the 32-bit input.

Add 32-bit values with wraparound.

Combine values with bitwise AND.

Divide left to right using unsigned integer division.

Multiply 32-bit values with wraparound.

Invert all 32 bits.

Combine values with bitwise OR.

Subtract subsequent values from the first value.

Reverse the order of four bytes.

Combine values with bitwise exclusive OR.

Shift left, discarding bits above bit 31.

Rotate bits to the left.

Rotate bits to the right.

Shift right and fill with zeros.

Normalize a number to an unsigned 32-bit value.

Format a number as eight lowercase hexadecimal digits.

Invalidates a cached object reference.

Checks for a cached object reference.

Represents replacement of a cached reference.

Compares the identity of object references.

Provides the runtime registry entry point.

Represents copying of a function or closure.

Compares closure implementations.

Represents inspection of a thread environment.

Represents interception of function behavior.

Describe function interception through the prototype-oriented API.

Represents interception of signal callbacks.

Identifies native closures.

Identifies closures associated with the module.

Reports function interception state.

Identifies Luau closures.

Identifies wrappers created by the module.

Represents compilation of source text into a function.

Represents creation of a native-style function wrapper.

Represents restoration of a function's previous behavior.

Describe restoration in the prototype-oriented interception API.

Represents restoration of signal callback behavior.

Represents control of a function's stack visibility.

Clear console output and reset the cursor.

Create the native console if necessary.

Detach the native console and reset visibility state.

Print an error message with [ERROR] prefix.

Hide the existing native console window.

Print an informational message with [INFO] prefix.

Read one line from the native console.

Set the title of the native console.

Print a value to the native console.

Show the native console, creating it if needed.

Toggle visibility of an existing console window.

Change the console's always-on-top state.

Print a warning with [WARN] prefix.

Decode Base64 text into the original bytes.

Encode a binary string as Base64 text.

Decrypt Base64-encoded AES-256-CBC data.

Encrypt local data using AES-256-CBC.

Generate random bytes and return them as Base64.

Generate a Base64-encoded 256-bit key.

Calculate a hexadecimal digest of local bytes.

Calculate an HMAC-SHA256 authentication code.

Compress bytes into a raw LZ4 block.

Expand a raw LZ4 block.

Generate a raw binary string of random bytes.

Function fingerprinting API.

Describe the module's classification of the current call stack.

Describe the current chain of function calls.

Represents inspection of a function constant.

Represents inspection of function constants.

Provides descriptive function or frame metadata.

Describe metatable information associated with a value.

Represents inspection of a function prototype.

Represents inspection of nested function prototypes.

Provides the debug registry entry point.

Reports environment optimization metadata.

Represents inspection of stack-frame values.

Represents inspection of an individual captured value.

Represents inspection of captured closure values.

Represents modification of a function constant.

Describe changes to a value's metatable association.

Represents changes to environment optimization metadata.

Represents modification of a stack-frame value.

Represents modification of a captured closure value.

Describe whether a call-stack level is available.

Function information for debugging.

Describe the current runtime capability metadata.

Read aggregate memory accounted for by the current Luau VM.

Identify a function by a diagnostic fingerprint.

Describe a script-associated runtime call stack.

Describe the execution-context category used by diagnostics.

Expose the script execution-time diagnostics entry point.

Describe a script's enclosing module relationship.

Describe source locations associated with script diagnostics.

Identify a thread associated with script diagnostics.

Describe the state reported for a script-associated thread.

Describe a frame in the current runtime call stack.

Read the current thread's allocated Luau stack capacity.

Script pause status.

Script pause control.

Store a named local callback in the diagnostics registry.

Replace a local table's contents while preserving its identity.

Script resume control.

Represent changes to runtime capability metadata.

Release a callback previously registered under a name.

Clears retained drawing objects.

Removes a retained drawing object.

Creates a retained drawing object.

Reads a drawing object property.

Describe the rendering window's capture-visibility status.

Identifies drawing objects.

Describe the selected drawing capture-visibility mode.

Describe capture-visibility settings for the rendering window.

Updates a drawing object property.

Describe the drawing capture-visibility mode.

Represents an outlined circle drawing command.

Represents a filled circle drawing command.

Represents a filled quadrilateral drawing command.

Represents a filled rectangle drawing command.

Represents a filled triangle drawing command.

Provides a paint object for the drawing lifecycle.

Represents a line drawing command.

Represents an outlined text drawing command.

Represents an outlined quadrilateral drawing command.

Represents an outlined rectangle drawing command.

Represents a text drawing command.

Represents an outlined triangle drawing command.

Clears a paint object's drawing state.

Connects a paint object to its drawing callback.

Disconnects a paint object's callback.

Clears work queued for an environment transition.

Represents recovery of source-like script text.

Reports the module's name.

Represents inspection of runtime feature flags.

Reports the configured frame-rate limit.

Provides the module's global environment entry point.

Represents access to the module's UI container.

Represents loading of object resources.

Represents inspection of thread identity metadata.

Reports the module's identity and version information.

Represents queued work across environment transitions.

Represents serialization of runtime object data.

Represents modification of runtime feature flags.

Represents configuration of a frame-rate limit.

Represents control of thread identity metadata.

Ask the user to select one existing file.

Ask the user to select one or more existing files.

Ask the user to select a filesystem folder.

Ask the user to choose a destination filename.

Append bytes to a workspace file.

Append bytes to a local file asynchronously.

Copy a file to another workspace path.

Delete one workspace file.

Recursively delete a workspace subfolder.

Local script-execution API.

Local asset integration API.

Get the size of a workspace file in bytes.

Check whether a workspace path is an existing file.

Check whether a workspace path is an existing folder.

List immediate children of a workspace folder.

Local script-loading API.

Describe asynchronous preparation of a local script file.

Create a workspace folder and missing parents.

Move a file or folder within the workspace.

Read all bytes from a workspace file.

Read a local file asynchronously.

Rename or relocate a workspace file or folder.

Create or overwrite a workspace file.

Create or replace a local file asynchronously.

Provides the module's HTTP GET entry point.

Provides the module's HTTP POST entry point.

Provides the module's general HTTP request entry point.

Reads text from the system clipboard.

Provides the module's device identifier.

Describe the module's cursor-visibility setting.

Describe whether a key is currently held down.

Describe a key's toggle state.

Reports whether the application window is active.

Checks whether a desktop window is active.

Describe the module's cursor-confinement status.

Represents a keyboard key click.

Represents a keyboard key press.

Represents a keyboard key release.

Describe confining the cursor to the active window area.

Displays a native message dialog.

Represents a primary mouse button click.

Represents a primary mouse button press.

Represents a primary mouse button release.

Represents a secondary mouse button click.

Represents a secondary mouse button press.

Represents a secondary mouse button release.

Represents absolute mouse pointer movement.

Represents relative mouse pointer movement.

Represents mouse wheel scrolling.

Writes text to the system clipboard.

Describe changing the module's cursor-visibility setting.

Describe releasing the local cursor-confinement mode.

Creates another reference to an existing object.

Provides an inventory of cached object references.

Enumerates runtime objects.

Enumerates objects without a parent.

Represents inspection of simulation-radius settings.

Provides additional object metadata.

Enumerates threads associated with an object.

Reports network ownership metadata.

Describe an interface object's local protection classification.

Describe local protection management for an interface object.

Represents modification of simulation-radius settings.

Describe leaving the local interface-protection mode.

Represents inspection of the current dispatched method name.

Represents access to raw metatable metadata.

Represents interception of metamethod behavior.

Reports whether a table is marked read-only.

Represents marking a table as read-only.

Represents marking a table as writable.

Represents modification of method-dispatch metadata.

Represents replacement of raw metatable metadata.

Represents control of a table's read-only state.

Clears the contents of a packet-stream object.

Reports the size of a packet-stream object.

Represents packet-stream transmission.

Represents a packet-stream object as a string.

Represents appending data to a packet stream.

Represents a double-precision value in a packet stream.

Represents a single-precision value in a packet stream.

Represents appending text to a packet stream.

Represents a 16-bit value in a packet stream.

Represents a 32-bit value in a packet stream.

Represents an 8-bit value in a packet stream.

Represents registration of an incoming-packet callback.

Represents registration of an outgoing-packet callback.

Creates a packet-stream object.

Represents control of packet-capture pause state.

Clears packet-log records.

Represents network synchronization controls.

Provides network synchronization timing metadata.

Provides packet-log metadata.

Represents local receive-side packet event processing.

Represents removal of an incoming-packet callback.

Represents removal of an outgoing-packet callback.

Represents raw packet transmission.

Represents transmission of a packet-stream object.

Represents inspection of internal property values.

Represents inspection of callback members.

Represents inspection of a hidden property.

Represents enumeration of hidden properties.

Additional object configuration information.

Represents enumeration of object properties.

Reports property scriptability metadata.

Represents modification of callback members.

Represents modification of a hidden property.

Represents modification of property scriptability metadata.

Return the first matching substring.

Collect all non-overlapping matches.

Replace the first match in a string.

Escape text for a literal match in a regex pattern.

Compile an ECMAScript regular expression.

Identifies the origin of the current call.

Represents filtered inspection of runtime objects.

Enumerates runtime threads.

Identifies script metadata associated with the caller.

Represents inspection of garbage-collected runtime objects.

Enumerates loaded module scripts.

Represents inspection of a module script environment.

Represents access to the host runtime environment.

Enumerates scripts marked as running.

Represents access to a script's bytecode representation.

Represents access to a script's callable representation.

Finds script metadata associated with a thread.

Represents identification of a script by its hash.

Read the display name associated with a script object.

Enumerates script objects known to the runtime.

Finds a thread associated with a script.

Represents inspection of a script environment.

Identifies threads associated with the module.

Reports whether a signal is eligible for replication.

Represents deferred dispatch of a connection callback.

Represents temporary disabling of an event connection.

Disconnects an event connection.

Represents re-enabling of an event connection.

Represents direct dispatch of a connection callback.

Represents deferred signal dispatch.

Represents activation of a click detector.

Represents activation of a proximity interaction.

Represents dispatch of a signal.

Represents a touch interaction.

Provides an alternative signal connection inventory.

Provides metadata for an individual connection.

Describe the handler function associated with a connection.

Enumerates signal connection metadata.

Describe the coroutine associated with a connection.

Inspect an object-style member associated with an event.

Reports proximity interaction timing metadata.

Enumerates render-step callback metadata.

Represents inspection of signal arguments.

Provides signal argument metadata.

Provides signal eligibility metadata.

Describe whether a connection is marked enabled.

Describe a connection's relationship to the current script environment.

Describe the Luau classification of a connection.

Describe the interception status associated with a signal.

Describe a connection associated with a waiting coroutine.

Represents signal replication behavior.

Represents modification of proximity interaction timing.

Registers a callback on a local Signal object.

Dispatches a notification to local Signal listeners.

Creates a local Signal facade object.

Registers a one-time callback on a local Signal object.

Represents waiting for a local Signal notification.

Removes a local Signal listener.

Represents discovery of actor states.

Represents discovery of the application state.

Represents discovery of a Luau state.

Represents execution associated with a state proxy.

Enumerates actors associated with a state proxy.

Creates a state proxy object.

Describe whether a coroutine has executor-context classification.

Provides metadata about a registered dispatch callback.

Provides original-thread metadata.

Provides root callback metadata.

Represents registration of a thread-dispatch callback.

Identifies a thread associated with dispatch interception.

Reports thread-dispatch interception state.

Represents replacement of a dispatch callback.

Represents removal of a thread-dispatch callback.

Describe executor-context classification for a coroutine.

Represents a specialized dispatch entry point.

Create a duration from days.

Create a duration from hours.

Create a duration from microseconds.

Create a duration from milliseconds.

Create a duration from minutes.

Create a duration from months.

Create a duration from nanoseconds.

Create a duration from seconds.

Create a duration from years.

Read the current wall-clock duration since the epoch.

Clear the elapsed total and stop the stopwatch.

Start or resume elapsed-time measurement.

Stop measuring and keep the accumulated time.

Create a stopped stopwatch.

Closes a WebSocket connection.

Represents creation of a WebSocket connection.

Represents sending a message on a WebSocket connection.