peanut-framework / Classes/Expressions/molang / Molang

Class: Molang

Molang class used to construct Molang expressions.

Constructors

new Molang()

new Molang(expression?): Molang

Parameters

expression?

string

Returns

Molang

Properties

expression

expression: string = "";

Methods

constBool()

constBool(value): Molang

Adds a constant boolean to a Molang expression.

Parameters

value

boolean

Boolean value.

Returns

Molang

---

constNum()

constNum(value): Molang

Adds a constant number to a Molang expression.

Parameters

value

number

Int or float value.

Returns

Molang

---

constStr()

constStr(value): Molang

Adds a constant string to a Molang expression.

Parameters

value

number

String value.

Returns

Molang

---

flowStatement()

flowStatement(statement): Molang

Adds a flow statement to a Molang expression.

Parameters

statement

MolangFlowStatement

Statement to add.

Returns

Molang

---

math()

math(mathFunction, ...args): Molang

Adds a math function to a Molang expression.

Parameters

mathFunction

MolangMathFunction

Function to execute.

args

...any[]

Argument(s) to pass to the function.

Returns

Molang

---

operator()

operator(operator): Molang

Adds an operator to a Molang expression.

Parameters

operator

MolangOperator

Operator to add.

Returns

Molang

---

query()

query(
   queryFunction, 
   inverted?, ...
   args?): Molang

Adds a query function to a Molang expression.

Parameters

queryFunction

MolangQueryFunction

Function to query.

inverted?

boolean

args?

...any[]

Argument(s) to pass to the function.

Returns

Molang

---

string()

string(str): Molang

Adds a string directly to a Molang expression.

Parameters

str

string

String to add.

Returns

Molang

---

variable()

variable(name): Molang

Calls a variable in a Molang expression.

Parameters

name

string

Variable name to call.

Returns

Molang

---

conditional()

static conditional(
   condition, 
   ifTrue, 
   ifFalse?): Molang

Adds a conditional expression using a binary or ternary operator.

Parameters

condition

string

Condition to evaluate.

ifTrue

string

Evaluate true condition.

ifFalse?

string

Evaluate false condition.

Returns

Molang

---

logic()

static logic(
   value1, 
   value2, 
   operator): Molang

Performs a logical operation or comparison between two expressions or values.

Parameters

value1

Molang expression or value to compare with.

string | number | boolean | Molang

value2

Molang expression or value to compare against.

string | number | boolean | Molang

operator

MolangOperator

Molang operator for comparison.

Returns

Molang