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

docs: spelling mistakes correction

Browse Source
This commit is contained in:
Julien Higginson
2025-01-11 14:22:55 +01:00
parent 575003433f
commit f0e8bfeb02
30 changed files with 201 additions and 175 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,3 +1,4 @@
# Standard Library
The standard library offers a number of miscellaneous utility functions, which can be used for various purposes. These are the most commonly used functions, so the standard library is almost certain to be included in the host program.
@@ -57,19 +58,19 @@ This function returns the value of any integer or float passed in, rounded to th
This function expects an integer or float as the value for `self`.
If `self` is below 0, this function returns -1. Otherwise it returns 1.
If `self` is below 0, this function returns -1. Otherwise, it returns 1.
### normalize(self): int
This function expects an integer or float as the value for `self`.
If `self` is below 0, this function returns -1. Otherwise if `self` is above 0, this function returns 1. Otherwise it returns 0.
If `self` is below 0, this function returns -1. Otherwise, if `self` is above 0, this function returns 1. Otherwise it returns 0.
### clamp(value, min, max): any
This function expects integers or floats as the values for `value`, `min`, and `max`.
If `value` is smaller than `min`, this function will return `min`. Otherwise, if `value` larget than `max`, it will return `max`. Otherwise, it will return `value`.
If `value` is smaller than `min`, this function will return `min`. Otherwise, if `value` larger than `max`, it will return `max`. Otherwise, it will return `value`.
### lerp(start, end, amount): any
@@ -81,23 +82,23 @@ This function will return the value of `start` adjusted towards the value of `en
### concat(self, other): any
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`.
This function only works when self and others 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`.
### containsKey(self: dictionary, key): bool
This function returns `true` if `self` contains the given `key`, otherwise it returns false.
This function returns `true` if `self` contains the given `key`; otherwise, it returns false.
### containsValue(self, value): bool
This function returns `true` if `self` contains the given `value`, otherwise it returns false.
This function returns `true` if `self` contains the given `value`; otherwise, it returns false.
### every(self, func: fn): bool
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `false`, at which point this function returns `false`. Otherwise this function returns `true`.
This function takes either an array or a dictionary as the `self` argument and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `false`, at which point this function returns `false`. Otherwise, this function returns `true`.
### forEach(self, func: fn)
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time.
This function takes either an array or a dictionary as the `self` argument and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func` one element at a time.
```
import standard;
@@ -113,7 +114,7 @@ a.forEach(p); //prints 1, 3, and 5 to stdout
### filter(self, func: fn): any
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, and the function returns a new compound for every element that `func` returned a truthy value for.
This function takes either an array or a dictionary as the `self` argument and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, and the function returns a new compound for every element that `func` returned a truthy value for.
### getKeys(self: dictionary): [any]
@@ -129,7 +130,7 @@ This function returns the first index within `self` that is equal to `value`, or
### map(self, func: fn): any
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. It returns an array with the results of each call - the order of the results when called on a dictionary are undefined.
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. It returns an array with the results of each call - the order of the results when called on a dictionary is undefined.
```
import standard;
@@ -145,13 +146,13 @@ print a.map(increment); //prints [2,3,4];
### reduce(self, default: any, func: fn): any
This function takes either an array or a dictionary as the `self` argument, a default value, and a function as `func`. The argument `func` takes three arguments - the first is the accumulator, the second is the index/key and the third is the value. It applies the given function to every element of the array/dictionary, passing the result of each call as the accumulator to the next (the default value is used for the first call). Finally, the final value of the accumulator is returned to the caller.
This function takes either an array or a dictionary as the `self` argument, a default value, and a function as `func`. The argument `func` takes three arguments - the first is the accumulator, the second is the index/key, and the third is the value. It applies the given function to every element of the array/dictionary, passing the result of each call as the accumulator to the next (the default value is used for the first call). Finally, the final value of the accumulator is returned to the caller.
```
import standard;
fn f(acc, k, v) {
return acc + v;
return acc + v;
}
var a = [1, 2, 3, 4];
@@ -161,11 +162,11 @@ print a.reduce(0, f); //prints "10"
### some(self, func: fn): bool
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `true`, at which point this function returns `true`. Otherwise this function returns `false`.
This function takes either an array or a dictionary as the `self` argument, and a function as `func`. The argument `func` must take two arguments - the first is the index/key of the array/dictionary, and the second is the value. The contents of `self` are passed into `func`, one element at a time, until `func` returns `true`, at which point this function returns `true`. Otherwise, this function returns `false`.
### sort(self: array, func: fn)
This function takes an array as the `self` argument, and a comparison function as `func`. The argument `func` must take two arguments, and return a truthy or falsy value. The contents of the array in `self` are sorted based on the results of `func`, as though the function were the less comparator function.
This function takes an array as the `self` argument, and a comparison function as `func`. The argument `func` must take two arguments and return a truthy or falsy value. The contents of the array in `self` are sorted based on the results of `func`, as though the function was the less comparator function.
```
import standard;
@@ -211,3 +212,5 @@ This function is identical to `trim(self, trimChars)`, except it is only applied
### trimEnd(self: string, trimChars: string = " \t\n\r"): string
This function is identical to `trim(self, trimChars)`, except it is only applied to the end of the first argument.