ocarina/src/doc/signals.txt

48 lines
1.2 KiB
Plaintext

Documentation for signals, and where they are emitted
cli-loop-begin:
Called at the beginning of every loop in the cli
Emitted in plugins.cline.loop.loop()
cli-loop-end:
Called at the end of every loop in the cli
Emitted in plugins.cline.loop.loop()
message-write:
Displays text to the screen
Emitted in core.bt.message.write()
Registered in core.bt.message
Registered in plugins.cline.loop.init()
Removed in plugins.cline.loop.quit()
Stopped in plugins.cline.message.insert()
scion-begin:
Begins a main loop for the program.
Emitted in core.scion.main()
Registered in plugins.cli.Plugin.open()
Registered in extra.sgtk.Plugin.open()
Removed in plugins.cli.Plugin.close()
Removed in extra.sgtk.Plugin.close()
scion-end:
Ends the main loop and closes all plugins
Emitted in plugins.exit.run()
Registered in plugins.manager.Manager.__init__()
Registered in plugins.cli.Plugin.open()
Registered in extra.sgtk.Plugin.open()
Removed in plugins.cli.Plugin.close()
Removed in extra.sgtk.Plugin.close()
scion-plugins-loaded:
Called right after loading all the plugins (before restoring settings or
enabling any plugins)
Emitted in core.scion.main()
Registered in core.session