Class MissionFlyByNode

Node used to describe a fly-by mission around a target object

Implements

MissionNodeBase<FLY_BY>

Index

Constructors

constructor

Methods

describe describeNextTask equals getTargetSystems isCompleted serialize setState updateState

Constructors

constructor

new MissionFlyByNode(
    objectId: {
        idInSystem: string;
        systemCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        };
    },
): MissionFlyByNode
Parameters
- objectId: {
      idInSystem: string;
      systemCoordinates: {
          localX: number;
          localY: number;
          localZ: number;
          starSectorX: number;
          starSectorY: number;
          starSectorZ: number;
      };
  }
  - idInSystem: string
  - systemCoordinates: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    }
    The coordinates of the star system.
    
    localX: number
    Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
    
    localY: number
    Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
    
    localZ: number
    Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
    
    starSectorX: number
    Integer coordinates of the star sector along the universe X axis
    
    starSectorY: number
    Integer coordinates of the star sector along the universe Y axis
    
    starSectorZ: number
    Integer coordinates of the star sector along the universe Z axis
Returns MissionFlyByNode
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:48

Methods

describe

describe(
    originSystemCoordinates: {
        localX: number;
        localY: number;
        localZ: number;
        starSectorX: number;
        starSectorY: number;
        starSectorZ: number;
    },
    starSystemDatabase: StarSystemDatabase,
): string
Describes the node recursively.
Parameters
- originSystemCoordinates: {
      localX: number;
      localY: number;
      localZ: number;
      starSectorX: number;
      starSectorY: number;
      starSectorZ: number;
  }
  The seed of the system where the mission has been given.
  - localX: number
    Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localY: number
    Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - localZ: number
    Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
  - starSectorX: number
    Integer coordinates of the star sector along the universe X axis
  - starSectorY: number
    Integer coordinates of the star sector along the universe Y axis
  - starSectorZ: number
    Integer coordinates of the star sector along the universe Z axis
- starSystemDatabase: StarSystemDatabase
Returns string
Implementation of MissionNodeBase.describe
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:125

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
Implementation of MissionNodeBase.describeNextTask
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:142

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
Implementation of MissionNodeBase.equals
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:65

getTargetSystems

getTargetSystems(): {
    localX: number;
    localY: number;
    localZ: number;
    starSectorX: number;
    starSectorY: number;
    starSectorZ: number;
}[]
Returns the target systems of the subtree.

Returns {
    localX: number;
    localY: number;
    localZ: number;
    starSectorX: number;
    starSectorY: number;
    starSectorZ: number;
}[]
- localX: number
  Floating point X coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
- localY: number
  Floating point Y coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
- localZ: number
  Floating point Z coordinate of the star system inside the star sector. Must be between -0.5 and 0.5.
- starSectorX: number
  Integer coordinates of the star sector along the universe X axis
- starSectorY: number
  Integer coordinates of the star sector along the universe Y axis
- starSectorZ: number
  Integer coordinates of the star sector along the universe Z axis
Implementation of MissionNodeBase.getTargetSystems
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:173

isCompleted

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

Returns boolean
Implementation of MissionNodeBase.isCompleted
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:61

serialize

serialize(): {
    objectId: {
        idInSystem: string;
        systemCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        };
    };
    state: FlyByState;
    type: FLY_BY;
}
Serializes the node recursively.

Returns {
    objectId: {
        idInSystem: string;
        systemCoordinates: {
            localX: number;
            localY: number;
            localZ: number;
            starSectorX: number;
            starSectorY: number;
            starSectorZ: number;
        };
    };
    state: FlyByState;
    type: FLY_BY;
}
Implementation of MissionNodeBase.serialize
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:177

setState

setState(state: FlyByState): void
Set the state of the fly-by mission. Useful when deserializing an ongoing mission.
Parameters
- state: FlyByState
  The state of the mission
Returns void
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:57

updateState

updateState(context: MissionContext): void
Updates the state of the node recursively.
Parameters
- context: MissionContext
  The mission context.
Returns void
Implementation of MissionNodeBase.updateState
- Defined in src/ts/frontend/missions/nodes/actions/sightseeing/missionFlyByNode.ts:70

Class MissionFlyByNode

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

idInSystem: string

systemCoordinates: { localX: number; localY: number; localZ: number; starSectorX: number; starSectorY: number; starSectorZ: number;}

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

Returns MissionFlyByNode

Methods

describe

Parameters

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

Returns string

describeNextTask

Parameters

Returns string

equals

Parameters

Returns boolean

getTargetSystems

Returns { localX: number; localY: number; localZ: number; starSectorX: number; starSectorY: number; starSectorZ: number;}[]

localX: number

localY: number

localZ: number

starSectorX: number

starSectorY: number

starSectorZ: number

isCompleted

Returns boolean

serialize

Returns { objectId: { idInSystem: string; systemCoordinates: { localX: number; localY: number; localZ: number; starSectorX: number; starSectorY: number; starSectorZ: number; }; }; state: FlyByState; type: FLY_BY;}

setState

Parameters

Returns void

updateState

Parameters

Returns void

Settings

On This Page

systemCoordinates: {
localX: number;
localY: number;
localZ: number;
starSectorX: number;
starSectorY: number;
starSectorZ: number;
}

Returns {
localX: number;
localY: number;
localZ: number;
starSectorX: number;
starSectorY: number;
starSectorZ: number;
}[]

Returns {
objectId: {
idInSystem: string;
systemCoordinates: {
localX: number;
localY: number;
localZ: number;
starSectorX: number;
starSectorY: number;
starSectorZ: number;
};
};
state: FlyByState;
type: FLY_BY;
}