Relintai/pandemonium_engine_easy_charts
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine_easy_charts.git synced 2025-01-17 14:47:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
fenix-hub 2020-05-14 14:26:27 +02:00 committed by GitHub
parent 485cb61bf7
commit c7db1650f5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -66,7 +66,7 @@ You can get this result:
![codep](imgs/code_point.png) ![codep](imgs/code_point.png)
![debug1](imgs/debug_point.png) ![debug1](imgs/debug_point.png)
*Table of features:* ### Table of features
**Chart** **Chart**
| Function | Description | | Function | Description |
@ -80,12 +80,14 @@ You can get this result:
|`chart_plotted(chart : Node)`|Returns the plotted Chart, which is a Node (Control, 2D Node, 3D Node)| |`chart_plotted(chart : Node)`|Returns the plotted Chart, which is a Node (Control, 2D Node, 3D Node)|
|`point_pressed(point : Point)`|Returns the point pressed with Left Click, which is a custom class *Point*| |`point_pressed(point : Point)`|Returns the point pressed with Left Click, which is a custom class *Point*|
**Legend** **Legend**
| Function | Description | | Function | Description |
| ------------- | ------------- | | ------------- | ------------- |
|`get_function() -> Array`|Get the function's name, also visible in legend| |`get_function() -> Array`|Get the function's name, also visible in legend|
|`get_function_color() -> Color`|Get the function's color, also visible in legend| |`get_function_color() -> Color`|Get the function's color, also visible in legend|
**Point** **Point**
| Function | Description | | Function | Description |
| ------------- | ------------- | | ------------- | ------------- |
@ -93,6 +95,23 @@ You can get this result:
|`get_function() -> String`|Get the point's function name, also visible in legend and chart| |`get_function() -> String`|Get the point's function name, also visible in legend and chart|
|`get_color_point() -> Color`|Get the point Color, also visible in legend and chart| |`get_color_point() -> Color`|Get the point Color, also visible in legend and chart|
**About templates**
Templates are defined in a .json file, and the format is pretty straight forward. You can use a reference the already present templates.
However, adding custom templates is not yet recommended, since it would require to edit the Charts scripts. Templates are anyway accessible and customizable.
```
/addons/easy_charts/templates.json
"default":
{
"function_colors" : ["#1e1e1e","#1e1e1e","#1e1e1e","#1e1e1e"],
"v_lines_color" : "#cacaca",
"h_lines_color" : "#cacaca",
"outline_color" : "#1e1e1e",
"font_color" : "#1e1e1e"
},
```
# Available Charts and when to use them # Available Charts and when to use them
This library offers a set of chart for each main Godot Node: This library offers a set of chart for each main Godot Node:
- **Control Nodes:** "Control Charts" are fast Charts that can be plotted in a Control space, such as UIs or Control user interactable areas. They offer basic Control properties, such as Margins, size inheritance and control. No animations, no real time changes, just charts. - **Control Nodes:** "Control Charts" are fast Charts that can be plotted in a Control space, such as UIs or Control user interactable areas. They offer basic Control properties, such as Margins, size inheritance and control. No animations, no real time changes, just charts.