Skip to main content

Module wire

Module wire 

Source
Expand description

The encoded form of the script surface: the version the shapes below are pinned at, and the adapters for the two property-store types ScriptCommand::SetProperty carries. The encoded form of the script surface.

A script host does not have to live in the engine’s address space. When it does not, the values it is called with, the commands it emits, and the signatures it was described with all travel as bytes, so their encoding is part of the contract rather than an implementation detail.

Most types derive their encoding. The two that cannot are PropertyKey and PropertyValue, which ScriptCommand::SetProperty carries: they are storage types, and the adapters live here so the storage layer stays free of an encoding it has no other use for.

Modules§

property_key
PropertyKey on the wire.
property_value
PropertyValue on the wire.

Enums§

PluginEvent
Something a plugin or a capability pushes at the engine outside a call.

Constants§

SCRIPT_WIRE_VERSION
Encoding version of the script surface.

Functions§

push_plugin_event
Push one event onto the bus, from inside the engine’s own address space.