GuidesAPI Reference
|
Back to site
Reference

API Reference

Overview of the Nodeal API surface — globals, game extensions, and module boilerplate.

API Reference

This section provides comprehensive technical documentation for the Nodeal API surface. It covers global functions, extensions to standard Roblox objects, and the module boilerplate required for the virtualization layer.

Tip

Use the sidebar to jump directly to specific global functions or game extensions. Every entry includes a detailed signature, parameter list, and a practical code example.

1. Quick Navigation

AreaDescriptionPrimary Docs
GlobalsNew and enhanced global functions.Globals
Game ExtensionsMethods added to the game object.Game Extensions
Built-insStandard library injections.Built-ins

2. Core Global Methods

Nodeal injects several "Power Globals" to handle dependency resolution and advanced object virtualization.

FunctionPrimary Use Case
import(name)Resolve and load a module by its registered name.
newproxy(target)Wrap an object with a custom, secure metatable.
typeof(value)Type-checking that respects __type overrides.
unpack(target)Unpack tables or proxies with support for __unpack.

3. Module Boilerplate

For a module to be compatible with Nodeal's security and virtualization layer, it must follow this strict boilerplate pattern:

-- 1. Initialize security accessor
local __=_G()
-- 2. Define your logic
local module = {}
function module:DoSomething()
    -- code ...
end
-- 3. Return via the accessor
return __(module)

Why this unique return?

The __(module) call allows the Nodeal runtime to:

  1. Verify the caller's execution permissions.
  2. Inject virtualized globals into the caller's scope if necessary.
  3. Apply decorators to the returned functions.
Caution

Attempting to return a table directly (without the __() wrapper) will cause a runtime error and a Pre-Parser warning, as it bypasses the security layer.