Class StateCondition

constructor

• new StateCondition(
      operator: Operator,
      unk1: number,
      state: number,
      leftOperandType: OperandType,
      leftOperandValue: number,
      rightOperandType: OperandType,
      rightOperandValue: number,
  ): StateCondition

  A condition for a state. If the condition is true, the state that the condition leads to will activate.

  Parameters

  • operator: Operator

    Controls what operation should be used for the condition.

  • unk1: number

    Unknown. Seems to always be 2 in vanilla Elden Ring. 3 seems to make the condition always false.

  • state: number

    If the condition is true, the state at this index will be checked next. If this index is -1, the effect will terminate instead.

  • leftOperandType: OperandType

    Controls what type of value the operand to the left of the operator should be.

  • leftOperandValue: number

    This does different things depending on the leftOperandType:

    Operand type	Value description
    Literal	The value is the operand's value.
    External	The value refers to an external value to use as the operand's value.
    UnkMinus2	The value is ignored and should be null.
    StateTime	The value is ignored and should be null.

  • rightOperandType: OperandType

    Controls what type of value the operand to the right of the operator should be.

  • rightOperandValue: number

    This does different things depending on the rightOperandType:

    Operand type	Value description
    Literal	The value is the operand's value.
    External	The value refers to an external value to use as the operand's value.
    UnkMinus2	The value is ignored and should be null.
    StateTime	The value is ignored and should be null.

  Returns StateCondition

leftOperandType

leftOperandValue

operator

rightOperandType

rightOperandValue

state

unk1

clone

• clone(): StateCondition

  Returns StateCondition

formatCondition

• formatCondition(): StateCondition

  The GreaterThanOrEqual and GreaterThan operators are not valid operators in the FXR format. This method returns an equivalent condition that is valid.

  Returns StateCondition

sortOperands

• sortOperands(): StateCondition

  Swaps the operands and changes the operator to match if the left operand is a literal value and the right operand is a non-literal value. This makes it a bit easier to read the expression, but doesn't affect functionality.

  Returns StateCondition

toString

• toString(): string

  Returns string

Staticfrom

• from(expression: string | StateCondition): StateCondition

  Parses a logical expression in a string and creates a StateCondition from it.

  Parameters

  • expression: string | StateCondition

    A string with a logical expression and optionally a then statement with a state index.

    Syntax:

    expression = <operand> <operator> <operand> then <stateIndex>
    operand = <number> | External(<integer>) | StateTime | UnkMinus2
    operator = == | != | < | <= | > | >=
    stateIndex = <positive integer> | -1 | terminate
    Copy

    External, StateTime, and UnkMinus2 are all case-insensitive and have shorter variations available. Here are some examples:

    ext(0)
    stateTime
    time
    minus2
    Copy

    Examples:

    ext(0) >= 1 then -1
    time > 5 then 2
    1 != External(10000) then terminate
    Copy

  Returns StateCondition

  A new StateCondition based on the expression.