Skip to content

internal.systemInterfaces

orciument edited this page Nov 16, 2024 · 1 revision

Warning

This page is very outdated and is missing critical information. Take everything on here with a grain of salt.

System Interfaces are a group of interfaces that are used to interface with the Core Systems/Framework of the Bot. They are intended to be used to tightly integrate a module with the Bot while retaining the independence of the module so that it can be removed at any time, without breaking other code. These interfaces also help adding complicated or quality of live features to a module which would otherwise not get these Features because of the development Time, or complexity.

A Example for that would be resettable caches. Being able to reset caches from a Web Panel would be very usefull for fixing issues in the short term, but implementing a Web Controller and a UI in the Panel for each Cache individually would not be a good time investment. The ResetableCache Interface helps with this by giving the developer a way to use the Core Bot system to manage his caches for him. The interface is only used to 'register' your cache with the system and provide some Information that will be displayed in the Panel. The Bot then adds it into a overview of all resetable caches in the Panel where you can reset each cache individually or reset all at once.

Clone this wiki locally