Skip to content

ModSignalingApi

Enables inter-mod communication.

Description

The ModSignalingApi is intended to be used for inter-mod communication. It uses the existing signal system but offers connect_deffered to connect to a signal either immediately or whenever it actually becomes available. It furthermore emits signal_registered ( String signal_id ) when a new user signal is added to it.

Methods

void add_user_signal ( String signal_id, Array arguments = [] )
void connect_deferred ( String signal_id, Object target, String method, Array binds = [], int flags = 0 )

Signals

signal_registered ( String signal_id ):
Emitted whenever a new user signal is added to the ModSignalingAPi.

Method Descriptions

void connect_deferred ( String signal_id, Object target, String method, Array binds = [], int flags = 0 ):
Forwards the call directly to Object#connect if a signal signal_id exists. Otherwise queues the call and runs it when a user signal signal_id is added.

void add_user_signal ( String signal_id, Array arguments = [] ):
Overrides Object#add_user_signal. Additionally emits signal_registered ( String signal_id ) after the user signal has been added.