\r\n\r\n> The shapez toolbar api\r\n\r\n## About\r\n\r\nTo have less conflicts between mods and toolbars an api was created.\r\n\r\n## Developing using the api\r\n\r\nThe api has a npm package [@dj1tjoo/shapez-toolbar-switcher](https://www.npmjs.com/package/@dj1tjoo/shapez-toolbar-switcher). This package contains helper funtion you can use in your mod.\r\n\r\nThe package exports the ToolbarSwitcher class. On this class are static methods to help you\r\n\r\nThe ToolbarSwitcher class has the following methods. The methods with a `*` can only be accessed after the preload state. You can use `onLoaded` to make a callback from when the preload state is over.\r\n\r\n| Method | Usage |\r\n| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |\r\n| requireInstalled(): void | Shows a dialog on the main menu when the toolbar switcher mod is not installed |\r\n| registerToolbar(id: string, toolbar: typeof HUDBaseToolbar, isVisible?: boolean): void | Registers a new toolbar if the toolbar switcher mod is installed |\r\n| addNewBuildingToToolbar({ toolbar: string, location: primary \\| secondary, metaClass: MetaBuilding, fallback?: regular \\| wires }): void | Registers a new building to a toolbar |\r\n| `*` isInstalled(): boolean | Returns if the toolbar switcher mod is installed |\r\n| `*` getMod(): AdvancedEnergyMod \\| null; | Returns the toolbar switcher mod instance |\r\n| `*` getVersion(): string \\| null; | Returns the version of the toolbar switcher mod instance |\r\n| onLoaded(cb: (installed: boolean) => void): void | Register to run callback on toolbar switcher loaded |\r\n| enableDebug(): void | Enables debug rendering on connectors |\r\n| disableDebug(): void | Disables debug rendering on connectors |\r\n\r\n### Usage examples\r\n\r\nThe example uses the [shapez cli](https://www.npmjs.com/package/create-shapezio-mod). All the `shapez` imports can be swapped out for their `shapez.` equivalent\r\n\r\n#### Registering a toolbar\r\n\r\n```js\r\nimport { HUDBaseToolbar } from \"shapez/game/hud/parts/base_toolbar\";\r\n\r\nexport class MyToolbar extends HUDBaseToolbar {\r\n constructor(root) {\r\n super(root, {\r\n primaryBuildings: [],\r\n secondaryBuildings: [],\r\n visibilityCondition: () =>\r\n !this.root.camera.getIsMapOverlayActive() && this.root.currentLayer === \"regular\",\r\n htmlElementId: \"ingame_HUD_my_toolbar\",\r\n layer: \"regular\",\r\n });\r\n }\r\n}\r\n```\r\n\r\nDon't forget to change the layer if nessesary and to give the toolbar a z-index\r\n\r\n```css\r\n#ingame_HUD_my_toolbar {\r\n z-index: 400;\r\n}\r\n```\r\n\r\nIn mod init():\r\n\r\n```js\r\nToolbarSwitcher.registerToolbar(\"myToolbar\", MyToolbar);\r\n```\r\n\r\n#### Registering a building to a toolbar\r\n\r\nIn mod init():\r\n\r\n```js\r\nToolbarSwitcher.addNewBuildingToToolbar({\r\n location: \"primary\",\r\n toolbar: \"myToolbar\",\r\n metaClass: MetaMyBuilding,\r\n fallback: \"regular\",\r\n});\r\n```\r\n","readmeFilename":"readme.md"}
![\"Version\"](\"https://img.shields.io/npm/v/@dj1tjoo/shapez-toolbar-switcher.svg\")
\r\n \r\n