Skip to main content

network kit

12 tools. Generated from the plugin source; do not edit by hand.

Tools​

Legend. risk 0 = read-only, 1 = harmless editor op, 2 = modifies asset, 3 = deletes/replaces asset, 4 = project/config/build op, 5 = potentially destructive (calls above MaxAutoRisk need "_confirm": true). mutates = runs in a transaction (edit.undo reverts). requires PIE / requires world = refused without a PIE session / an open level. requires plugin = unavailable while the plugin is disabled. dryRun = honours the dryRun argument. smoke = covered by edit.self_test.

network.get_actor_state (risk 0, requires world, smoke)​

Reports an editor-world actor's roles, bound driver and current replication values.

ArgumentTypeDescription
actorstringrequired. Editor-world actor label, name, or path.

Returns: state.

network.get_class_replication_defaults (risk 0, smoke)​

Returns portable replication defaults from an actor class default object.

ArgumentTypeDescription
classstringrequired. Actor class, Blueprint asset, or generated class path.

Returns: replication.

network.get_connection_state (risk 0, requires PIE)​

Returns one live connection's public driver role and object identity with endpoint data redacted.

ArgumentTypeDescription
connectionstringrequired. Connection object path reported by network.list_connections.

Returns: connection.

network.get_iris_status (risk 0, UE 5.0+, smoke)​

Reports whether Iris runtime modules are present and already loaded; it never enables Iris or changes driver configuration.

No arguments.

Returns: feature, present, loaded, modules, message.

network.get_replication_graph_status (risk 0, smoke)​

Reports whether the ReplicationGraph plugin/module is present and already loaded; it never loads or configures it.

No arguments.

Returns: feature, present, loaded, modules, message.

network.get_rpc_function (risk 0, smoke)​

Returns one RPC's reflected flags and input parameters.

ArgumentTypeDescription
functionstringrequired. RPC function name.

Returns: class, rpc.

network.get_runtime_diagnostics (risk 0, smoke)​

Summarizes live world net modes and public net-driver connection state.

No arguments.

Returns: netModes, notes.

network.list_connections (risk 0, requires PIE, smoke)​

Lists live client/server connection objects for PIE without exposing endpoint addresses.

No arguments.

Returns: connections, count.

network.list_net_drivers (risk 0, smoke)​

Lists public net drivers associated with every live engine world context.

No arguments.

Returns: drivers, worldCount, driverCount.

network.list_rep_notifies (risk 0, smoke)​

Lists replicated properties with RepNotify callbacks and their reflected callback names.

ArgumentTypeDescription
nameContainsstringCase-insensitive function or property-name substring.
includeInheritedbooleanInclude members inherited from parent classes. Default true.

Returns: class, properties, count.

network.list_replicated_properties (risk 0, smoke)​

Lists reflected properties marked for replication without editing Blueprint or component settings.

ArgumentTypeDescription
nameContainsstringCase-insensitive function or property-name substring.
includeInheritedbooleanInclude members inherited from parent classes. Default true.

Returns: class, properties, count.

network.list_rpc_functions (risk 0, smoke)​

Lists RPC functions and their direction, reliability and input parameters.

ArgumentTypeDescription
nameContainsstringCase-insensitive function or property-name substring.
includeInheritedbooleanInclude members inherited from parent classes. Default true.

Returns: class, rpcs, count.