Skip to content

Commit 1b4c7d5

Browse files
committed
Readme
1 parent 9ccee12 commit 1b4c7d5

File tree

1 file changed

+1
-32
lines changed

1 file changed

+1
-32
lines changed

README.md

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -19,35 +19,4 @@ Simulate the behavior of the gravitation between celestial objects.
1919
* Press <kbd>Esc</kbd> to pause / continue.
2020

2121
## Scripts
22-
If you are running a custom script, you can use the following variables, functions & modules.
23-
Make sure you use these variables & functions with a ```self.``` in front of them
24-
25-
### Variables
26-
* ```running```: bool (used for the main loop)
27-
* ```paused```: bool (used for physics)
28-
* ```g```: float | int
29-
* ```delta_time```: float
30-
* ```bodies```: list
31-
* ```current_body```: Body | None (when creating a body with <kbd>Leftclick</kbd>, the body gets stored inside this variable)
32-
* ```dragged_body```: Body | None (when moving a body with <kbd>Rightclick</kbd>, the body gets stored inside this variable)
33-
* ```config_surf```: ui.Surface
34-
* ```fps_text```: ui.Text
35-
* ```run_button```: ui.Button
36-
* ```mass_input```: ui.InputField
37-
* ```radius_input```: ui.InputField
38-
* ```g_input```: ui.InputField
39-
* ```path_length_input```: ui.InputField
40-
* ```path_multiplier_input```: ui.InputField
41-
* ```draw_lines_input```: ui.Checkbox
42-
* ```bg_alpha_input```: ui.InputField
43-
44-
## Functions
45-
* ```runScript```
46-
* ```createBody```
47-
* ```handleBodies```
48-
* ```run```
49-
50-
## Modules
51-
* ```ui```
52-
* ```pygame```
53-
* ```tk```
22+
If you are running a custom script, you can use everything, that is inside the [Gravitator.Application class](Gravitator/app.py). Make sure to write ```self.``` infront of the variables and methods you are using.

0 commit comments

Comments
 (0)