add time.isbpl docs

This commit is contained in:
Daniella / Tove 2022-05-24 07:32:17 +02:00
parent 065ad9c987
commit dbaa63785d
2 changed files with 81 additions and 39 deletions

View file

@ -1,39 +0,0 @@
# Documentation: time.isbpl
## Functions
### `sleep ::: delay -> `
Delay in millis
### `delay ::: delay -> `
Delay in millis
### `delays ::: delay -> `
Delay in seconds
### `getms ::: -> ms`
Returns current unix millis
### `time ::: delay -> currentUnixMillis`
Native to assist with time. Sleeps delay and returns current unix
millis.
## Variables
### Timer
The Timer type.

81
docs/tine.md Normal file
View file

@ -0,0 +1,81 @@
# Documentation: time.isbpl
## Functions
### `sleep ::: delay -> `
Delay in millis
### `delay ::: delay -> `
Delay in millis
### `delays ::: delay -> `
Delay in seconds
### `getms ::: -> ms`
Returns current unix millis
### `time ::: delay -> currentUnixMillis`
Native to assist with time. Sleeps delay and returns current unix
millis.
## Variables
### Timer
The Timer type.
---
# Types
## Timer
Type to time the duration of operations
### Methods
#### `start ::: -> `
Starts the timer
#### `timeTaken ::: -> ms`
Returns the number of millis between the last start & end calls
#### `end ::: -> `
Stops the timer
### Variables
#### startMS
unix timestamp of last start call
#### timeTakenTMP
Temporary to store a cached value of the time taken
#### stopMS
unix timestamp of last stop call