krgamestudios/Toy
1
0
Fork 0
mirror of https://github.com/krgamestudios/Toy.git synced 2026-04-15 23:04:08 +10:00
Code Issues Packages Projects Releases Wiki Activity

Updated standard library

Browse Source
This commit is contained in:
Kayne Ruse
2023-02-27 21:38:02 +11:00
committed by GitHub
parent 1ac49def37
commit 3d317ff28e
1 changed files with 45 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
getting-started/standard-library.md
View File

@@ -8,14 +8,56 @@ The standard library can usually be accessed with the `import` keyword:
import standard;
```
## abs(self)
This function returns the absolute value of any integer or float passed in.
# Misc. Utilities
<hr />
## clock()
This function returns a string representation of the current timestamp.
## hash(self)
This function returns a hashed value of `self`.
This function uses the internal literal hashing algorithms. As such, the following can't be hashed:
* functions
* types
* opaques
* `null`
Any attempt to hash these will return -1, except `null` which returns 0.
# Maths Utilities
<hr />
## abs(self)
This function returns the absolute value of any integer or float passed in.
## ceil(self): int
This function returns the value of any integer or float passed in, rounded up.
## floor(self): int
This function returns the value of any integer or float passed in, rounded down.
## max(...)
This function returns the value of the highest integer or float passed in. It can take any number of arguments.
## min(...)
This function returns the value of the lowest integer or float passed in. It can take any number of arguments.
## round(self): int
This function returns the value of any integer or float passed in, rounded to the nearest whole number.
# Compound Utilities
<hr />
## concat(self, other)
This function only works when self and other are matching compounds (both arrays, dictionaries or strings). It returns a new compound of that kind, with the content of `other` appended to the content of `self`.
@@ -60,19 +102,6 @@ This function returns an array of all non-null keys stored within the dictionary
This function returns an array of all values with non-null keys stored within the dictionary. The order is undefined.
## hash(self)
This function returns a hashed value of `self`.
This function uses the internal literal hashing algorithms. As such, the following can't be hashed:
* functions
* types
* opaques
* `null`
Any attempt to hash these will return -1, except `null` which returns 0.
## indexOf(self: array, value)
This function returns the first index within `self` that is equal to `value`, or `null` if none are found.