Class StateCondition

constructor

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

  A condition for a state. The state remains active if all of its conditions are true or if it has no conditions. If the condition is false, the state is deactivated and the next state (nextState) is activated.

  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 true.
  • nextState: number

    If the condition is false, the state at this index will be checked next. Set it to -1 to disable the sfx if the condition is false.
  • 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:

    • OperandType.Literal: This value is the operand's value.
    • OperandType.External: This value refers to an external value to use as the operand's value.
    • OperandType.UnkMinus2: This value is ignored and should be null.
    • OperandType.StateTime: This 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:

    • OperandType.Literal: This value is the operand's value.
    • OperandType.External: This value refers to an external value to use as the operand's value.
    • OperandType.UnkMinus2: This value is ignored and should be null.
    • OperandType.StateTime: This value is ignored and should be null.

  Returns StateCondition

leftOperandType

leftOperandValue

nextState

operator

rightOperandType

rightOperandValue

unk1

clone

• clone(): StateCondition

  Returns StateCondition

formatCondition

• formatCondition(): StateCondition

  The LessThanOrEqual and LessThan 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 an else statement with a state index.

    Syntax:

    expression = <operand> <operator> <operand>[ else[ goto] <stateIndex>]
    operand = <number> | External(<integer>) | StateTime | UnkMinus2
    operator = != | == | > | >= | < | <=
    stateIndex = <integer> | none
    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
    time < 5 else goto 2
    1 != External(10000) else 1
    Copy

  Returns StateCondition

  A new StateCondition based on the expression.