Added part of docs
This commit is contained in:
55
docs/en/reference/index.md
Normal file
55
docs/en/reference/index.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Type reference
|
||||
|
||||
List of data types available in scripts for the Piklib/BlooMoo engine. The list will be filled in as individual pages are written.
|
||||
|
||||
## Types used in scripts
|
||||
|
||||
### Primitives
|
||||
|
||||
- [BOOL](BOOL.md) — boolean value.
|
||||
- [DOUBLE](DOUBLE.md) — double-precision floating-point number.
|
||||
- [INTEGER](INTEGER.md) — signed integer number.
|
||||
- [STRING](STRING.md) — character string.
|
||||
|
||||
### Collections
|
||||
|
||||
- [ARRAY](ARRAY.md) — one-dimensional array.
|
||||
- [MULTIARRAY](MULTIARRAY.md) — multi-dimensional array with automatic resizing.
|
||||
|
||||
### Logical conditions
|
||||
|
||||
- [CONDITION](CONDITION.md) — comparison of two operands.
|
||||
- [COMPLEXCONDITION](COMPLEXCONDITION.md) — combination of two conditions with `AND`/`OR`.
|
||||
|
||||
### Code structure
|
||||
|
||||
- [BEHAVIOUR](BEHAVIOUR.md) — procedure.
|
||||
- [CLASS](CLASS.md) — class definition.
|
||||
|
||||
### Scene hierarchy
|
||||
|
||||
- [APPLICATION](APPLICATION.md) — top of the script hierarchy.
|
||||
- [EPISODE](EPISODE.md) — logical segment of the game.
|
||||
- [SCENE](SCENE.md) — a single scene.
|
||||
|
||||
### Built-in I/O objects
|
||||
|
||||
- [KEYBOARD](KEYBOARD.md) — keyboard state.
|
||||
- [MOUSE](MOUSE.md) — mouse state.
|
||||
- [RAND](RAND.md) — pseudo-random number generator.
|
||||
- [SYSTEM](SYSTEM.md) — system information.
|
||||
|
||||
### Media
|
||||
|
||||
- [ANIMO](ANIMO.md) — animation from an `.ANN` file.
|
||||
- [FONT](FONT.md) — bitmap font definition.
|
||||
- [IMAGE](IMAGE.md) — static image.
|
||||
- [SEQUENCE](SEQUENCE.md) — animation sequence with synchronised audio.
|
||||
- [SOUND](SOUND.md) — short sound effect.
|
||||
- [TEXT](TEXT.md) — on-screen text element.
|
||||
|
||||
## Remaining types
|
||||
|
||||
Pages for the following types will be added next:
|
||||
|
||||
BUTTON, CANVAS_OBSERVER, CNVLOADER, DATABASE, EXPRESSION, GROUP, INERTIA, MATRIX, PATTERN, STATICFILTER, STRUCT, TIMER, VECTOR, VIRTUALGRAPHICSOBJECT, WORLD.
|
||||
Reference in New Issue
Block a user