Skip to content

Commit c7c09d1

Browse files
committed
Inserted Documentation
1 parent cec70e5 commit c7c09d1

37 files changed

Lines changed: 587 additions & 0 deletions

Docs/.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/_book/
2+
/node_modules/
3+
/public/
4+
/book.pdf
5+
/book.mobi
6+
/book.epub
7+
/package-lock.json

Docs/API/attributes.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Attributes
2+
3+
## Types
4+
5+
There are two supported types:
6+
7+
#### Int32 Attr
8+
9+
Attributes using Int32 as the value type.
10+
11+
#### Float Attr
12+
13+
Attributes using Float as the value type.
14+
15+
## Usage
16+
17+
Note that Int32 and Float share the exact same API.
18+
19+
### Creating an attribute
20+
21+
To create a float attribute we just need to create a variable of type *"Float Attr"* or *"Int32 Attr"*.
22+
23+
![Float Attribute](img\float-attribute.png)
24+
25+
We can now edit the base value of the attribute.
26+
27+
28+
29+
### Read base and final values
30+
31+
The next two functions expose this values:
32+
33+
![Read Value](img\read-attr-value.png)

Docs/API/img/category-priority.png

51.6 KB
Loading

Docs/API/img/category-settings.png

16.3 KB
Loading

Docs/API/img/factor-base-pct.png

53.8 KB
Loading

Docs/API/img/factor-pct-2.png

53.7 KB
Loading

Docs/API/img/factor-pct.png

39.5 KB
Loading

Docs/API/img/factor-scalar.png

38.8 KB
Loading

Docs/API/img/factors.png

5.81 KB
Loading

Docs/API/img/float-attribute.png

21.4 KB
Loading

0 commit comments

Comments
 (0)