\r\n\r\n> The shapez pipe api\r\n\r\n## About\r\n\r\nTo have less conflicts between mods and pipes an api was created. This api makes use of a network system. All transfers within a network are instant.\r\n\r\n## Developing using the api\r\n\r\nThe api has a npm package [@dj1tjoo/shapez-pipes](https://www.npmjs.com/package/@dj1tjoo/shapez-pipes). This package contains helper funtion you can use in your mod.\r\n\r\nThe package exports the Pipes class. On this class are static methods to help you\r\n\r\nThe Pipes class exposes the api components. All the api components 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| Component | Usage |\r\n| ------------------------------------ | -------------------------------------------------------------------- |\r\n| PipeConnectorComponent | A component to make connections with in a newtwork (E.g. simple connector, storage) |\r\n| PipePinComponent | A component to take and add fluids to a network (E.g. fluid producer, building that uses fluid)|\r\n| PipeTunnelComponent | A component to make connections with in a newtwork with other buildings in between |\r\n| BaseFluid | The base for creating a new fluid|\r\n| gFluidRegistry | Register the new fluid |\r\n| typeFluidSingleton | The type for storing fluids|\r\n\r\nThe Pipes 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 pipes mod is not installed |\r\n| registerFluid(createFluidClass: () => typeof BaseFluid): void | Registers the fluid class created in the callback |\r\n| `*` isInstalled(): boolean | Returns if the pipes mod is installed |\r\n| `*` getMod(): AdvancedEnergyMod \\| null; | Returns the pipes mod instance |\r\n| `*` getVersion(): string \\| null; | Returns the version of the pipes mod instance |\r\n| onLoaded(cb: (installed: boolean) => void): void | Register to run callback on pipes loaded |\r\n| enableDebug(): void | Enables debug rendering on connectors |\r\n| disableDebug(): void | Disables debug rendering on connectors |\r\n\r\n### Fluid example\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```js\r\nimport { Pipes } from \"@dj1tjoo/shapez-pipes\";\r\nimport { globalConfig } from \"shapez/core/config\";\r\nimport { Loader } from \"shapez/core/loader\";\r\n\r\nexport const Water = Pipes.registerFluid(\r\n () =>\r\n class WaterFluid extends Pipes.BaseFluid {\r\n static getId() {\r\n return \"water_fluid\";\r\n }\r\n\r\n equalsImpl() {\r\n return true;\r\n }\r\n\r\n /**\r\n * Draws the item to a canvas\r\n * @param {CanvasRenderingContext2D} context\r\n * @param {number} size\r\n */\r\n drawFullSizeOnCanvas(context, size) {\r\n if (!this.cachedSprite) {\r\n this.cachedSprite = Loader.getSprite(\"sprites/fluids/water.png\");\r\n }\r\n this.cachedSprite.drawCentered(context, size / 2, size / 2, size);\r\n }\r\n\r\n /**\r\n * @param {number} x\r\n * @param {number} y\r\n * @param {number} diameter\r\n * @param {import(\"shapez/core/draw_utils\").DrawParameters} parameters\r\n */\r\n // @ts-ignore\r\n drawItemCenteredClipped(x, y, parameters, diameter = globalConfig.defaultItemDiameter) {\r\n const realDiameter = diameter * 0.6;\r\n if (!this.cachedSprite) {\r\n this.cachedSprite = Loader.getSprite(\"sprites/fluids/water.png\");\r\n }\r\n this.cachedSprite.drawCachedCentered(parameters, x, y, realDiameter);\r\n }\r\n\r\n getBackgroundColorAsResource() {\r\n return \"#2389DA\";\r\n }\r\n }\r\n);\r\n```\r\n\r\nThe register will export a class with two static properties:\r\n`SINGLETON` and `Class`. Use the `SINGLETON` for where you need to enter fluids (e.g. in a pipe pin slot)\r\n\r\n### Adding a pipe pin\r\n\r\nThe `entity.addComponent` can be called in a buildings `setupEntityComponents`\r\n\r\n```js\r\nentity.addComponent(\r\n new Pipes.PipePinComponent({\r\n slots: [\r\n {\r\n direction: enumDirection.top,\r\n pos: new Vector(0, 0),\r\n type: \"ejector\",\r\n productionPerTick: 100,\r\n maxBuffer: 1000,\r\n fluid: Water.SINGLETON,\r\n },\r\n {\r\n direction: enumDirection.bottom,\r\n pos: new Vector(0, 0),\r\n type: \"acceptor\",\r\n consumptionPerTick: 100,\r\n maxBuffer: 1000,\r\n fluid: Steam.SINGLETON,\r\n },\r\n ],\r\n })\r\n);\r\n```\r\n","readmeFilename":"readme.md"}
![\"Version\"](\"https://img.shields.io/npm/v/@dj1tjoo/shapez-pipes.svg\")
\r\n \r\n