Class Ship

Hierarchy

  • Ship

Implements

  • Account

Constructors

constructor

Properties

ACCOUNT_NAME MIN_DATA_SIZE

Accessors

data key

Methods

decodeData invalidateShip registerShip setNextShip updateShip

Constructors

constructor

  • Parameters

    • _data: AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>
    • _key: PublicKey

    Returns Ship

Properties

Static Readonly ACCOUNT_NAME

ACCOUNT_NAME: "craftingInstance" | "disbandedFleet" | "fleet" | "fleetShips" | "game" | "gameState" | "mineItem" | "planet" | "resource" | "sagePlayerProfile" | "sector" | "ship" | "star" | "starbase" | "starbasePlayer" | "surveyDataUnitTracker" = 'ship'

Static Readonly MIN_DATA_SIZE

MIN_DATA_SIZE: number = SHIP_MIN_DATA_SIZE

Accessors

data

  • get data(): Readonly<AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>>

  • Returns Readonly<AnchorTypeDef<Object, AnchorDefined<SageIDL, Record<string, never>>>>

key

  • get key(): PublicKey

  • Returns PublicKey

Methods

Static decodeData

  • Parameters

    Returns DecodedAccountData<Ship>

Static invalidateShip

  • Makes a Ship unusable; effectively removes it from use

    Returns

    InstructionReturn

    Parameters

    • program: SageIDLProgram

      SAGE program

    • key: AsyncSigner<unknown>

      the key authorized to run this instruction

    • profile: PublicKey

      the profile with the required permissions for the instruction

    • ship: PublicKey

      the ship

    • gameId: PublicKey

      the SAGE game id

    • keyIndex: number

      the index of the key in the profile permissions

    Returns InstructionReturn

Static registerShip

  • Register a new Ship

    Returns

    InstructionReturn

    Parameters

    • program: SageIDLProgram

      SAGE program

    • key: AsyncSigner<unknown>

      the key authorized to run this instruction

    • profile: PublicKey

      the profile with the required permissions for the instruction

    • ship: AsyncSigner<unknown>

      the ship

    • mint: PublicKey

      the ship's mint

    • gameId: PublicKey

      the SAGE game id

    • input: RegisterShipInput

      input params

    Returns InstructionReturn

Static setNextShip

  • Set the next Ship Essentially this invalidates the current Ship account and updates it to the next Ship

    Returns

    InstructionReturn

    Parameters

    • program: SageIDLProgram

      SAGE program

    • key: AsyncSigner<unknown>

      the key authorized to run this instruction

    • profile: PublicKey

      the profile with the required permissions for the instruction

    • ship: PublicKey

      the current ship

    • nextShip: PublicKey

      the ship that will be replacing the current ship

    • gameId: PublicKey

      the SAGE game id

    • keyIndex: number

      the index of the key in the profile permissions

    Returns InstructionReturn

Static updateShip

  • Update a Ship

    Returns

    InstructionReturn

    Parameters

    • program: SageIDLProgram

      SAGE program

    • key: AsyncSigner<unknown>

      the key authorized to run this instruction

    • profile: PublicKey

      the profile with the required permissions for the instruction

    • ship: PublicKey

      the ship

    • gameId: PublicKey

      the SAGE game id

    • input: UpdateShipInput

      input params

    Returns InstructionReturn

Settings

Member Visibility

Theme

Generated using TypeDoc