Skip to content

API Guide

Jump to bottom Edit New page
Alex Lementuev edited this page Mar 12, 2017 · 4 revisions

Public API List:

  • LunarConsolePlugin.LunarConsole.Show() - Shows the console on top of everything. Does nothing if current platform is not supported or if the plugin is not initialized.
  • LunarConsolePlugin.LunarConsole.Hide() - Hides the console. Does nothing if platform is not supported or if plugin is not initialized.
  • LunarConsolePlugin.LunarConsole.Clear() - Clears log messages. Does nothing if platform is not supported or if plugin is not initialized.
  • LunarConsolePlugin.LunarConsole.SetConsoleEnabled(bool enabled) - Sets console enabled or disabled. Disabled console cannot be opened by user or API calls and does not collect logs. Does nothing if platform is not supported or if plugin is not initialized.
  • LunarConsolePlugin.LunarConsole.onConsoleOpened { get; set; } - Callback method to be called when the console is opened. You can pause your game here.
  • LunarConsolePlugin.LunarConsole.onConsoleClosed { get; set; } - Callback method to be called when the console is closed. You can un-pause your game here.
  • LunarConsolePlugin.LunarConsole.RegisterAction(string name, Action action) - PRO only: Registers a user-defined action with a specific name and callback. Does nothing if platform is not supported or if plugin is not initialized. For more information check Actions and Variables guide.
  • LunarConsolePlugin.LunarConsole.UnregisterAction(Action action) - PRO only: Un-registers a user-defined action with a specific callback. Does nothing if platform is not supported or if plugin is not initialized. For more information check Actions and Variables guide.
  • LunarConsolePlugin.LunarConsole.UnregisterAction(string name) - PRO only: Un-registers a user-defined action with a specific name. Does nothing if platform is not supported or if plugin is not initialized. For more information check Actions and Variables guide.
  • LunarConsolePlugin.LunarConsole.UnregisterAllActions(object target) - PRO only: Un-registers all user-defined actions with a specific target (the object of the class which contains callback methods). Does nothing if platform is not supported or if plugin is not initialized. For more information check Actions and Variables guide.

Love using the plugin? Please, rate and review on the Asset Store!

Sidebar

Clone this wiki locally