API Usage

​

Shared

• manifest
  A table on all the attributes you set in the extension.
• capabilities
  Another table, this time with the permissions.
• remotes
  Allows you to access the Remotes for Orbit’s namespace.
  Uses ByteNet-Max.
  More Information in the future.
• Logger
  Debug API. Instead of prints we have a centralized log that prints by entering --orbit logs into the console.

function logger.Log(content: string) : boolean
function logger.Get(lines: number) : {[number]: string}

​

Shared (Permission-Based)

• Notify (UseNotif)
  An API that you always have access to.
  Allows you to send notifications.
  Leave out target if on client.
  export type onelinerData = {
  	message: string,
  	icon: string?,
  	duration: number?,
  }
  function notify:oneliner(target: Player?, data: onelinerData) : boolean
  
  export type twolinerData = {
  	title: string,
  	description: string,
  	icon: string?,
  	duration: number?,
  }
  function notify:twoliner(target: Player?, data: twolinerData) : boolean
  

​

Server

• permitted(userId: number, permission: string)
  A function exposed to check for permission. To see if someone has access to the panel, simply check for the Active permission.
• info
  A configuration instance provided, that allows you to read following info (through attributes):
  • thumbnail The game’s thumbnail.
  • description The game’s description.
  • icon The game’s icon.
  • serverCode The server code generated by networking. (Keep in mind this will not be changed if Networking is disabled)
  • uptime Uptime tracked by Orbit.
  • version The version of Orbit currently running.

​

Server (Permission-based)

• Webhook (UseWebhook)
  function Webhook.configuredUrl(): string
  export type Payload = string | {
    [string]: any
  }
  function Webhook.send(url: string?, message: Payload): (boolean, string?)
  

​

Client (Permission-based)

• contextmenu (UseContext)
  Allows usage of the context menu.
  export type ContextMenuData = {
  	Header: string,
  	Buttons: {
  		{
  			Icon: string,
  			Label: string,
  		}
  	},
  }
  export type SignalInstance = {
  	Connect = function(self, callback: () -> ()),
  	-- ...
  }
  export type Events = {
  	isHovering: boolean,
  	isInitialized: boolean,
  	ContextMenuOpened: boolean,
  	ButtonClicked: SignalInstance,
  }
  contextmenu:ContextMenu(State: boolean, Data: ContextMenuData?) : Events|{}
  
• navkit (UseNavkit)
  function navkit:_jumpToPage(button: ImageButton)
  function navkit:_bind(button: ImageButton)
  export type catdata = {
  	name: string,
  	layoutorder: number?,
  }
  function navkit.newCategory(identifier: string, catdata: catdata)
  function navkit.getCategory(identifier: string)
  export type navdata = {
  	category: string,
  	name: string,
  	icon: string?,
  	layoutorder: number?,
  	clone: boolean?,
  }
  function navkit.newButton(identifier: string, navdata: navdata, window: GuiObject)
  function navkit.deleteButton(identifier: string, category: string)
  
  We recommend keeping category identifiers like this: extension.category.
  A perfect example is Orbit’s categories.
  The Main category is under orbit.main, and More is under orbit.more.
  Both get created at runtime using .newCategory.
  
• modals (UseModals)
  function modalService.new(id: string, modal: GuiObject, constructor: ((modal: GuiObject, ...any) -> ())?) : GuiObject
  function modalService:switchTo(modal: string|GuiObject, data: {any}) : boolean
  function modalService:back()
  
  constructors allow you to change content of pages dynamically on call!
  For example, if it includes loading a user profile, you call modals:switchTo("profile", {userId = 1}) which will then be included into the constructor! modals.new("profile", profileModal, function(modal, userId) ... end)
• breadcrumbs
  Self-explanatory.
  breadcrumbs:_jumpTo(crumbs: {string})
  breadcrumbs:crumb(data: string, fromRoot: boolean?)
  
  The data on crumb can be formatted like this: Extension/Settings, or just Settings. FromRoot will set the crumb to Orbit/ and continue from there. Modals and Navkit do this automatically!