This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
cherrycore [2024/05/06 21:41] – onslaught | cherrycore [2024/05/07 17:54] (current) – onslaught | ||
---|---|---|---|
Line 1: | Line 1: | ||
{{:: | {{:: | ||
- | + | ======Cherry Core====== | |
- | ==== Cherry Core ==== | + | |
Line 11: | Line 10: | ||
==== Cherry Add-ons List==== | ==== Cherry Add-ons List==== | ||
- | ^ ^ Addon^ | + | ^ ^ Add-on^ |
- | | {{: | + | | {{: |
|::: |This add-on. Cherry Core is required for all other Cherry add-ons | |::: |This add-on. Cherry Core is required for all other Cherry add-ons | ||
- | | {{: | + | | {{: |
|::: |Utilizes Telegram' | |::: |Utilizes Telegram' | ||
+ | | {{: | ||
+ | |::: |Send in game messages directly to your discord server. Utilize commands to communicate directly with your friends and free company members and any other message based usage you can think of. Directly command and receive message from supported add-ons mods.| | ||
- | ====Cherry Connect API Referance==== | + | ====Cherry Connect API Reference==== |
- | Cherry Connect allows your add-on to send and receive messages from any Cherry communication | + | Cherry Connect allows your add-on to send and receive messages from any Cherry communication |
The Cherry Connect API is fairly simple and is accessed by the global variable | The Cherry Connect API is fairly simple and is accessed by the global variable | ||
Line 31: | Line 32: | ||
=== Main Communication function === | === Main Communication function === | ||
- | The function that is passed to CherryConnect.Register will be the function that which most user messages and commands will be routed. The exception would be CherryConnect.MessageOptions where the user-selected option will be routed directly to the specially supplied function. | + | The function that is passed to CherryConnect.Register will be the function that which most user messages and commands will be routed. The exception would be Cherry Connect.MessageOptions where the user-selected option will be routed directly to the specially supplied function. |
The When the user sends a message or command that is routed to cmd_func The signature will be function(result). The result will either be an error or a message result: | The When the user sends a message or command that is routed to cmd_func The signature will be function(result). The result will either be an error or a message result: | ||
Line 164: | Line 165: | ||
The mod name cannot conflict with any other mod or command. Mods do not share a 1 to 1 relationship with an add-on, so a single add-on can register multiple mods. | The mod name cannot conflict with any other mod or command. Mods do not share a 1 to 1 relationship with an add-on, so a single add-on can register multiple mods. | ||
- | **MOD_ID** Will be used in all the other API calls to identify which mod is making the call. The **MOD_ID** must be saved for as long as Cherry Core is not unloaded or until the mod is unregistered. Once the mod is unregistered you must re-register the mod to access a new **MOD_ID** | + | **MOD_ID** Will be used in all the other API calls to identify which mod is making the call. The **MOD_ID** must be saved for as long as Cherry Core is not unloaded or until the mod is unregistered. Once the mod is unregistered, you must re-register the mod to access a new **MOD_ID** |
{{: | {{: | ||
Line 178: | Line 179: | ||
//Notes// | //Notes// | ||
- | Most of the time you will not need to unregister a mod. The mod will need to be re-registered anytime the addons | + | Most of the time, you will not need to unregister a mod. The mod will need to be re-registered anytime the add-ons |
Line 224: | Line 225: | ||
* **mod_id** - // | * **mod_id** - // | ||
- | * The id of the mod that has been registered. | + | * The ID of the mod that has been registered. |
* **options** - // | * **options** - // | ||
* A list of options that the user has to select from. The options are in the format of: {" | * A list of options that the user has to select from. The options are in the format of: {" | ||
Line 260: | Line 261: | ||
Usage: | Usage: | ||
< | < | ||
- | Let' | + | Let the user's client know That the option has been received successfully |
* **mod_id** - // | * **mod_id** - // | ||
Line 269: | Line 270: | ||
* A simple message to the user acknowledging that the option was selected. | * A simple message to the user acknowledging that the option was selected. | ||
- | **returns** | + | **Returns** |
On errors: | On errors: |