Skip to content

Commit

Permalink
Adding variables section to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rumblesan committed Dec 29, 2021
1 parent 6fbe1d9 commit e2bf307
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,22 @@ The first value given needs to be a symbol that specifies which matrix transform
If a value is not given for a required axis then an error will occur.


## Variables

There are a small number of pre-defined variables available.

### time

This is the most useful and heavily used variable, and is responsible for all of the animation that happens. Its value is the number of seconds passed since Improviz started running, it's a floating point number, and it is always increasing.

### pi

The mathematical constant, has a fixed value of *3.1415927*

### aspectRatio

A floating point number that is the ratio between the screen width and height.

## Global

The global functions change general things about the Improviz environment. Currently this is really just the background colour.
Expand Down

0 comments on commit e2bf307

Please sign in to comment.