Documentation
Core
Elements
Condition

Condition

⚠️

This page is under construction.

⚠️

Beta feature, subject to change.

Condition allows you to create conditional branches in your story.

Condition
    .If((ctx) => {
        return // your condition here
    }, [
        character1.say`the condition is true`,
    ])
 
    .Else([
        character1.say`the condition is false`,
    ])

In usual cases, you may want to determine flags, or check the value of a variable. You can use Perdidtent to do this.

type PersistentData = {
    coin: number;
    flag: boolean;
    hobby: string;
};
 
const persis = new Persistent<PersistentData>("persis", {
    coin: 0,
    flag: false,
    hobby: "coding",
});
 
// check if the player has enough coins
Condition
    .If(persis.evaluate("coin", (coin) => coin < 50), [
        character1.say("you don't have enough coins"),
    ])
 
// check if the player has a flag
Condition
    .If(persis.isTrue("coin"), [
        character1.say("you have the flag"),
    ])
 
// check if the player has a hobby
Condition
    .If(persis.equals("hobby", "coding"), [
        character1.say("you like coding"),
    ])

Note: To better unerstand the script, if you call these methods in wrong order, it will throw an error.

For example, you cannot call ElseIf before If.

Static Methods

If

  • condition: Lambda | LambdaHandler<boolean> - The condition to check. If the condition is true, the actions will be executed. See Lambda and LambdaHandler for more information.
  • action: ChainedActions - ChainedActions
Condition.If(({ storable }) => {
    return (storable.getNamespace("name").get("coin") || 0) >= 10;
}, [
    character1.say("you have enough money")
])

Public Methods

constructor

Chainable Methods

ElseIf

  • condition: Lambda | LambdaHandler<boolean>
  • action: ChainedActions

Else

  • action: ChainedActions
ScriptControl