rtex-engine/docs/equals.md

35 lines
746 B
Markdown
Raw Normal View History

2022-12-29 14:17:56 -05:00
# equals
Returns true if the two values are equal, false otherwise.
## Parameters
* a (`integer`, `float`, `double`, `string`, `boolean`, `instruction`) - The first value to compare.
* b (`integer`, `float`, `double`, `string`, `boolean`, `instruction`) - The second value to compare.
## Return
(`boolean`) - True if the two values are equal, false otherwise.
## Exceptions
* `EvaluationException` - If there was an error while evaluating one or more parameters.
* `TypeException` - If one or more parameters are not of the expected type.
## Instruction Example
```json
{
"type": "equals",
"_": {
"a": "foo",
"b": "foo"
}
}
```
### Last Updated
Monday, December 29th, 2022.
Written by [Netkas](https://git.n64.cc/netkas)