isbpl/docs/time.md

82 lines
894 B
Markdown
Raw Normal View History

2022-05-24 07:32:17 +02:00
# Documentation: time.isbpl
2022-05-24 16:41:03 +02:00
## >Functions
2022-05-24 07:32:17 +02:00
### `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.
2022-05-24 16:41:03 +02:00
## >Variables
2022-05-24 07:32:17 +02:00
### Timer
The Timer type.
---
# Types
2022-05-24 16:41:03 +02:00
## >Timer
2022-05-24 07:32:17 +02:00
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