Interface MissionNodeBase<T>

Describes any node in the mission tree.

interface MissionNodeBase<T extends MissionNodeType> {
    describe(
        originSystemCoordinates: StarSystemCoordinates,
        starSystemDatabase: StarSystemDatabase,
    ): string;
    describeNextTask(
        context: MissionContext,
        keyboardLayout: Map<string, string>,
        starSystemDatabase: StarSystemDatabase,
    ): string;
    equals(other: MissionNode): boolean;
    getTargetSystems(): StarSystemCoordinates[];
    isCompleted(): boolean;
    serialize(): MissionNodeSerializedBase<T>;
    updateState(context: MissionContext): void;
}

Type Parameters

T extends MissionNodeType

Implemented by

Index

Methods

describe describeNextTask equals getTargetSystems isCompleted serialize updateState

Methods

describe

describe(
originSystemCoordinates: StarSystemCoordinates,
starSystemDatabase: StarSystemDatabase,
): string
Describes the node recursively.
Parameters
- originSystemCoordinates: StarSystemCoordinates
  The seed of the system where the mission has been given.
- starSystemDatabase: StarSystemDatabase
Returns string
- Defined in missions/nodes/missionNode.ts:49

describeNextTask

describeNextTask(
    context: MissionContext,
    keyboardLayout: Map<string, string>,
    starSystemDatabase: StarSystemDatabase,
): string
Describes the next task to be done in the mission subtree.
Parameters
- context: MissionContext
  The mission context.
- keyboardLayout: Map<string, string>
  The keyboard layout map to localize the keys.
- starSystemDatabase: StarSystemDatabase
Returns string
- Defined in missions/nodes/missionNode.ts:56

equals

equals(other: MissionNode): boolean
Returns true if the node is equal to another node, false otherwise.
Parameters
- other: MissionNode
  The other node to compare to.
Returns boolean
- Defined in missions/nodes/missionNode.ts:43

getTargetSystems

getTargetSystems(): StarSystemCoordinates[]
Returns the target systems of the subtree.

Returns StarSystemCoordinates[]
- Defined in missions/nodes/missionNode.ts:65

isCompleted

isCompleted(): boolean
Returns true if the node is completed, false otherwise.

Returns boolean
- Defined in missions/nodes/missionNode.ts:31

serialize

serialize(): MissionNodeSerializedBase<T>
Serializes the node recursively.

Returns MissionNodeSerializedBase<T>
- Defined in missions/nodes/missionNode.ts:70

updateState

updateState(context: MissionContext): void
Updates the state of the node recursively.
Parameters
- context: MissionContext
  The mission context.
Returns void
- Defined in missions/nodes/missionNode.ts:37