Skip to content

Commit

Permalink
Added function owner documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
virustotalop committed Sep 8, 2018
1 parent 0e3d5a2 commit 579064e
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion docs/functionapi/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,32 @@
Function Api
============

The function api or function manager as its known in DynamicGui is what is responsible for the registration of functions. Below you will find out how to write functions and add the functions to DynamicGui so they can be used in guis.
The function manager is what is responsible for the registration of functions. Below you will find out how to write functions and add the functions to the function manager so they can be used in guis.

=================
Making a function
=================

All functions have to extend the Function class. The function class allows you to work with the player and manipulate guis.

Below is an example of a simple function that... todo

===============
Function owners
===============

Most functions do not need to worry about the owner of the function. However there are certain operations where it would be useful to know the owner of the function. In DynamicGui function owners are split up slots and guis. Slots refer to the individual slots in a gui and a gui is the whole gui including the slots that make up the gui.

===========================
Making a slot only function
===========================



==========================
Making a gui only function
==========================



=================
Expand Down

0 comments on commit 579064e

Please sign in to comment.