> For the complete documentation index, see [llms.txt](https://mrgold.gitbook.io/discord-bot-builder/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mrgold.gitbook.io/discord-bot-builder/faq/blocks.md). # Blocks Under construction... ## Blocks are the Action Tools of your Bot. They are created with node JS and a Basic Structur for `name`, `inputs`, `options`,`output` and the `code` Part. ## How to Submit to DBB Its easy if you want to use them Only by yourself just Place the JS file in your Bot Directry and go on. If everything is ok with the file its getting Loaded instand without restarting DBB. Only if modifications on the File made that interacts with the Block (not the `code` part) DBB needs to be Restarted. If you want to make your Block Public send it to Gold (and grap your Blocks Dev rank in Discord :D ). ## The Line Types If you worked with DBB already you know that there are some different Colors for lines. These are to make it easyer for you to see what can be connected (is the same type of var) and not only for the Style :D. The differen types are: `unspecified, undefined, null, object, boolean, number, text, list, date, action` How to use them we'll see later. ## The Basic Structure ## 1. The default Structure: This Structur is the Block that get showed in the DBB-Editor, there you can place Stuff like Name, Description, Category and more. Please make shure that you arent use the same Name for tow Blocks! ```javascript module.exports = { name: "", description: "", category: "", inputs: [], options: [], outputs: [], code: function(cache) { } }; ``` *Note: Gold* **loves** *to see the the brake between the Object Keys ;), Simply add them befor sending it to him.* ## 2. The Inputs and Outputs: These are The Inputs and Outputs of your Block showen in DBB-Editor. *If you Update something here please restart the DBB-Editor to see it.* ```javascript inputs/outputs: [ { "name": "", "title": "", "description": "", "types": [] } ] // types : unspecified, undefined, null, object, boolean, number, text, list, date, action ``` In the `name` field gets the Name of the Variable used in the code section. Please make shure that the Names are Unique for the File. `title` is the Name how its shown in DBB-Editor itself. `description` is the Text that Pops up if you hover on the Connectionpoint in DBB-Editor. Helpfull to Descripe the Types here ;). `types` is an Array of Types that can be Connected here. If you want only one Type to be connected use `[ "yourtype" ]`. If you need more, use a comma seperated list inside the `[]` like this `[ "unspecified", "undefined", "null", "object" ]`. The `inputs` field is an Array of Objects. That mean you can add as many Inputs you need by cloning the Object and add it again. To make it valid, **between** the Objects **needs** to be a `,`. Thats for all fields from type Array or Object!!! Example: ```javascript inputs: [ { "name": "action", "title": "Action", "description": "Acceptable Types: Action\n\nDescription: Executes this block.", "types": ["action"] }, { "name": "value", "title": "Value", "description": "Acceptable Types: Unspecified, Undefined, Null, Object, Boolean, Number, Text, List\n\nDescription: ", "types": ["unspecified", "undefined", "null", "object", "boolean", "number", "text", "list"] } ] ... outputs: [ { "name": "action", "title": "Action", "description": "Type: Action\n\nDescription: Executes blocks.", "types": ["action"] } ] ``` ## 3. The Options: These are the Options of your Block showed in the DBB-Editor. *If you Update something here please restart the DBB-Editor to see it.* ### Basic Options ```javascript options: [ { "name": "", "title": "", "description": "", "type": "" } ] ``` ### The Option Types `type` supports `SELECT, TEXT, COLOR, NUMBER` By `type` => `COLOR` it will appere the Color-Picker to select a Color. *Note: Gold loves his Color-Picker, like it too and he likes you back ;D* By `type` => `TEXT` or `NUMBER` a Field to type your Value in shows on the Block in DBB. By `type` => `SELECT` a Dropdown Menu will be shown in DBB. If you use any other then `SELECT` you are fine with this Options Structure. If using `SELECT` you need to add the `options` field to the `options` Object. (yea sounds wired, just go on :D ) The new `options` filed is an Array of Items. ```javascript /** value for code => */ 1 : "Option to Select" /** <= Shown in DBB */ ``` #### The `options` in `options` array Example: ```javascript options:[ { "name": "", "title": "", "description": "", "type": "SELECT", "options": [ 1 : "Option to Select 1", 2 : "Option to Select 2", 3 : ... ] } ] ``` ## 4. The Code: The One and the only part that do something in your Bot. *All above is just to show it in the DBB Editor right.* For this Stuff you need some knowledge in Javascript. You can do mostly anything here. DBB always await the end of the Function to execute Block by Block. You only can controll where the Flow goes on. ```javascript code: function(cache){ } ``` ### The `cache` Object The `cache` Object includes the information arround the Block. Without this the `code` can't interact with the lines. *You only need it for the included funktions from **this**.* Example: ```javascript { "name":"", "index":"", "workspace":"", "inputs":{}, "outputs":{} } ``` `name` is the Block Name itself. `index` is the Number of the Block (out of DBB-Editor). `workspace` is a Number what it mean... IDK :=). `inputs` is the Array of your Input lines (only the ID's of the Line gets here). `outputs` is an Array of your Output Lines (only the ID's too). ### The `this` Object The `this` Object includes all activ Blocks (you **don't** need this) and some usefull Functions for you. ```javascript // Usefull stuff for you!! this.GetInputValue("linename", cache); this.GetOptionValue("linename", cache); this.StoreOutputValue(number, "linename", cache); this.RunNextBlock("linename", cache); this.require("npmmodul"); // Just ignore anything else ;) ``` With this functions you can get or store the Input-, Option- and Outputvalues or run the next Block. (with the right function) For Example here is the code Block from the Print Action. ```javascript code: function(cache) { const content = this.GetInputValue("value", cache); console.log(content); this.RunNextBlock("action", cache); } ``` `"value"` in `this.GetInputValue()` is defined in the `inputs` part of the Block. Its the same with `this.StoreOutputValue()`. It only can be use for Output Lines! Input Object from Block: ```javascript inputs: [ { "name": "action", "title": "Action", "description": "Acceptable Types: Action\n\nDescription: Executes this block.", "types": ["action"] }, { "name": "value", "title": "Value", "description": "Acceptable Types: Unspecified, Undefined, Null, Object, Boolean, Number, Text, List\n\nDescription: The value that you want to send to your console.", "types": ["unspecified", "undefined", "null", "object", "boolean", "number", "text", "list"] } ] ``` `"action"` in `this.RunNextBlock()` is defined in the `outputs` part of the Block. Output Object from Block: ```javascript outputs: [ { "name": "action", "title": "Action", "description": "Type: Action\n\nDescription: Executes blocks.", "types": ["action"] } ] ``` ### Modul loading with `this.require()` If you want to import an Module like `fs` or `path` that **aren't** downloaded **from npm**, simply use it like anywhere else, just put it inside the `code` field: Example: ```javascript code : function(cache){ const path = require("path"); // and go on like you wan't... } ``` If you want to import an Module like `discord.js` **from npm** please use `this.require()` like this: Example: ```javascript code : function(cache){ const discord = this.require("discord.js"); // and go on :) } ``` To improve Performance you should only use default Packages and if you need another, try to use a minimal libary of this function. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://mrgold.gitbook.io/discord-bot-builder/faq/blocks.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.