The SpaceshipReference Script

The Papyrus Index is still under construction. Structs have not been implemented yet.

No properties found.

• Found in:
  • Vanilla

  eventOnCombatStateChanged(ObjectReferenceakTarget, intaeCombatState)

  Event that is triggered when this spaceship's combat state against the target changes
  State is as follows:
  0 - not in combat
  1 - in combat
  2 - searching

• Found in:
  • Vanilla

  eventOnSpaceshipCombatListAdded(SpaceshipReferenceakTarget)

  Event that is triggered when this ship's pilot adds another ship's pilot to its combat list.

• Found in:
  • Vanilla

  eventOnSpaceshipCombatListRemoved(SpaceshipReferenceakTarget)

  Event that is triggered when this ship's pilot removes another ship's pilot from its combat list.

• Found in:
  • Vanilla

  eventOnEnterBleedout()

  Event received when a ship enters the essential down state.

• Found in:
  • Vanilla

  eventOnEscortWaitStart()

  Event received when this spaceship is in an Escort procedure and begins waiting for the escorted spaceship to catch up.

• Found in:
  • Vanilla

  eventOnEscortWaitStop()

  Event received when this spaceship is in an Escort procedure and stops waiting because the escorted spaceship has caught up.

• Found in:
  • Vanilla

  eventOnLocationChange(LocationakOldLoc, LocationakNewLoc)

  Event that is triggered when this spaceship changes from one location to another

• Found in:
  • Vanilla

  eventOnRecoverFromBleedout()

  Event received when a ship exits the essential down state.

• Found in:
  • Vanilla

  eventOnShipDock(boolabComplete, SpaceshipReferenceakDocking, SpaceshipReferenceakParent)

  Event received when a ship initiates and completes docking with a parent

• Found in:
  • Vanilla

  eventOnShipFarTravel(LocationaDepartureLocation, LocationaArrivalLocation, intaState)

  Event received when a ship begins or ends far travel - State { Departure = 0, Arrival = 1 }

• Found in:
  • Vanilla

  eventOnShipGravJump(LocationaDestination, intaState)

  Event received when a ship grav jump event occurs - State { Initiated = 0, AnimStarted = 1, Completed = 2, Failed = 3 }

• Found in:
  • Vanilla

  eventOnShipLanding(boolabComplete)

  Event received when a ship initiates or completes landing

• Found in:
  • Vanilla

  eventOnShipRampDown()

  Event recieved when a ship's landing ramp has lowereed all the way and connected to the surrounding navmesh

• Found in:
  • Vanilla

  eventOnShipRefueled(intaFuelAdded)

  Event that is triggered when fuel has been added to this spaceship

• Found in:
  • Vanilla

  eventOnShipScan(LocationaPlanet, ObjectReference[]aMarkersArray)

  Event that is triggered when the player scans a planet with this spaceship

• Found in:
  • Vanilla

  eventOnShipSystemPowerChange(ActorValueakSystem, boolabAddPower, boolabDamagedRelated)

  Event received when a ship system adds or removes power

• Found in:
  • Vanilla

  eventOnShipSystemDamaged(ActorValueakSystem, intaBlocksLost, boolaElectromagneticDamage, boolaFullyDamaged)

  Event that is triggered when one of this spaceship's systems loses a power block due to damage

• Found in:
  • Vanilla

  eventOnShipSystemRepaired(ActorValueakSystem, intaBlocksGained, boolaElectromagneticDamage)

  Event that is triggered when one of this spaceship's systems gains a power block due to being repaired

• Found in:
  • Vanilla

  eventOnShipTakeOff(boolabComplete)

  Event received when a ship initiates or completes takeoff

• Found in:
  • Vanilla

  eventOnDeath(ObjectReferenceakKiller)

  Event that is triggered when a spaceship dies

• Found in:
  • Vanilla

  eventOnDying(ObjectReferenceakKiller)

  Event that is triggered when a spaceship is dying

• Found in:
  • Vanilla

  eventOnKill(ObjectReferenceakVictim)

  Event that is triggered when a spaceship kills another spaceship

• Found in:
  • Vanilla

  eventOnShipUndock(boolabComplete, SpaceshipReferenceakUndocking, SpaceshipReferenceakParent)

  Event received when a ship initiates or completes undocking with a parent

• Found in:
  • Vanilla

  eventOnShipBought()

  Event this is triggered when a ship is bought

• Found in:
  • Vanilla

  eventOnShipSold()

  Event this is triggered when a ship is sold

• Found in:
  • Vanilla

  voidfunctionAddPerk(PerkakPerk, boolabNotify=false)Native

  Adds the specified perk to this actor

• Found in:
  • Vanilla

  voidfunctionAddToFaction(FactionakFaction)

  Adds this spaceship to a faction at rank 0 if they aren't already in it

• Found in:
  • Vanilla

  boolfunctionCanLandAtMarker(ObjectReferenceakLandingMarker)Native

  Tests if the spaceship is allowed to land at the given marker based on the maximum allowed ship size.

• Found in:
  • Vanilla

  intfunctionCheckContrabandStatus(boolabCheckWholeShip=true)Native

  Retrieves the ships contraband status. (Only checks ships cargo if abCheckWholeShip is false)
  -1 - Below shielded inventory limit
  0 - At shielded inventory limit
  1 - Above shielded inventory limit

• Found in:
  • Vanilla

  voidfunctionDisableWithGravJump()Native

  disable this spaceship with grav jump FX

• Found in:
  • Vanilla

  voidfunctionDisableWithGravJumpNoWait()Native

  disable this spaceship with grav jump FX. Does NOT wait for the FX to finish

• Found in:
  • Vanilla

  voidfunctionDisableWithTakeOffOrLanding()Native

  disable this spaceship after playing a takeoff or landing animation (whichever is appropriate)

• Found in:
  • Vanilla

  voidfunctionDisableWithTakeOffOrLandingNoWait()Native

  disable this spaceship after playing a takeoff or landing animation (whichever is appropriate). Does NOT wait for the animation to complete

• Found in:
  • Vanilla

  voidfunctionEnablePartRepair(ActorValueaSystemHealth, boolabEnable=true)Native

  Enable/disable repairing the spaceship part associated with the given System Health actor value
  If no part is specified, all the parts will be affected
  pass true to enable repairing the part(s), false to disable it

• Found in:
  • Vanilla

  voidfunctionEvaluatePackage(boolabResetAI=false)Native

  evaluate this spaceships packages.

• Found in:
  • Vanilla

  voidfunctionEnableAI(boolabEnable=true, boolabPauseVoice=false)Native

  enable or disable the AI for this ship

• Found in:
  • Vanilla

  boolfunctionEnableWithGravJump()Native

  enable this spaceship with grav jump FX

• Found in:
  • Vanilla

  boolfunctionEnableWithGravJumpNoWait()Native

  enable this spaceship with grav jump FX - does not wait for 3d to load

• Found in:
  • Vanilla

  boolfunctionEnableWithLanding()Native

  enable this spaceship and land it at its currently linked landing marker

• Found in:
  • Vanilla

  boolfunctionEnableWithLandingNoWait()Native

  enable this spaceship and land it at its currently linked landing marker. Does not wait for the animation to complete or the 3d to load

• Found in:
  • Vanilla

  SpaceshipReference[]functionGetAllCombatTargets()Native

  gets all the combat targets for this spaceship

• Found in:
  • Vanilla

  SpaceshipReferencefunctionGetCombatTarget()Native

  gets the current combat target

• Found in:
  • Vanilla

  floatfunctionGetContrabandWeight(boolabCheckWholeShip=true)Native

  Retrieves the ships contraband weight. (Only checks ships cargo if abCheckWholeShip is false)

• Found in:
  • Vanilla

  FactionfunctionGetCrimeFaction()Native

  Get the faction this ship reports crimes to

• Found in:
  • Vanilla

  PackagefunctionGetCurrentPackage()Native

  Gets this spaceships's current AI package

• Found in:
  • Vanilla

  ObjectReference[]functionGetExteriorLoadDoors()Native

  Gets all exterior references for this spaceship which are load doors

• Found in:
  • Vanilla

  ObjectReference[]functionGetExteriorRefs(KeywordapKeyword)Native

  Gets this spaceship's exterior references filtered by the given keyword

• Found in:
  • Vanilla

  intfunctionGetFactionRank(FactionakFaction)Native

  Obtains this spaceship's rank with the specified faction - returns -1 if the spaceship is not a member

• Found in:
  • Vanilla

  intfunctionGetActorFactionReaction(ActorakOtherActor)Native

  returns the faction reation to the other actor
  0 - Neutral
  1 - Enemy
  2 - Ally
  3 - Friend

• Found in:
  • Vanilla

  SpaceshipReference[]functionGetDockedShips()Native

  Retrieve all the spaceships currently docked with this spaceship

• Found in:
  • Vanilla

  intfunctionGetFactionReaction(SpaceshipReferenceakOther)Native

  returns the faction reation to the other spaceship
  0 - Neutral
  1 - Enemy
  2 - Ally
  3 - Friend

• Found in:
  • Vanilla

  SpaceshipReferencefunctionGetFirstDockedShip()Native

  Retrieve the first spaceship docked with this spaceship, if any

• Found in:
  • Vanilla

  ObjectReferencefunctionGetKiller()Native

  get this ship's killer

• Found in:
  • Vanilla

  ObjectReference[]functionGetLandingRamps()Native

  Gets all exterior references for this spaceship which are ramps

• Found in:
  • Vanilla

  intfunctionGetLevel()Native

  get the level of this spaceship

• Found in:
  • Vanilla

  SpaceshipBasefunctionGetLeveledSpaceshipBase()Native

  get the base object of this spaceship, either the created one for a leveled ship or the editor saved one for a non leveled ship.

• Found in:
  • Vanilla

  boolfunctionGetNoBleedoutRecovery()Native

  get the no bleedout recovery status for this ship

• Found in:
  • Vanilla

  intfunctionGetPartCount(intaiShipPartID)Native

  Gets the number of parts of a specific type
  valid aiShipPartIDs 0 - Weapons, 1 - Engine, 2 - Shields, 3 - Gravdrive, 4 - Generator

• Found in:
  • Vanilla

  intfunctionGetPartPower(intaiShipPartID, intaiShipPartIndex)Native

  Gets the amount of power allocated to a given part
  valid aiShipPartIDs 0 - Weapons, 1 - Engine, 2 - Shields, 3 - Gravdrive, 4 - Generator

• Found in:
  • Vanilla

  floatfunctionGetShipMaxCargoWeight()Native

  Gets the spaceships maximum weight capacity by summing normal and shielded cargo capacity.

• Found in:
  • Vanilla

  WeaponfunctionGetWeaponGroupBaseObject(ActorValueaWeaponGroupSystemHealth)Native

  Returns the weapon associated with a weapon group part

• Found in:
  • Vanilla

  boolfunctionHasPerk(PerkakPerk)Native

  Checks to see if this speaceship has the given Perk

• Found in:
  • Vanilla

  boolfunctionInstantDock(ObjectReferenceakTarget)Native

  Instantly docks the spaceship with a target which can be another ship or a docking port

• Found in:
  • Vanilla

  voidfunctionInstantUndock()Native

  Instantly undocks a spaceship

• Found in:
  • Vanilla

  boolfunctionIsAIEnabled()Native

  Returns whether this spaceship's AI is enabled.

• Found in:
  • Vanilla

  boolfunctionIsAlarmed()Native

  Returns if this spaceship is alarmed or not

• Found in:
  • Vanilla

  boolfunctionIsAlerted()Native

  Returns if this spaceship is alerted or not

• Found in:
  • Vanilla

  boolfunctionIsDead()Native

  check if this spaceship is dead

• Found in:
  • Vanilla

  boolfunctionIsDetectedBy(SpaceshipReferenceakOther)Native

  Returns if this spaceship is detected by the other one

• Found in:
  • Vanilla

  boolfunctionIsDocked()Native

  Get whether this spaceship is currently docked

• Found in:
  • Vanilla

  boolfunctionIsDockedWith(SpaceshipReferenceakTarget)Native

  Get whether this spaceship is currently docked with a given target

• Found in:
  • Vanilla

  boolfunctionIsDockedAsChild()Native

  Get whether this spaceship is docked as a child

• Found in:
  • Vanilla

  boolfunctionIsEssential(boolabIncludeActors=true)Native

  get if this spaceship is considered essential
  Included actors are anyone in the ship's interior or exterior

• Found in:
  • Vanilla

  boolfunctionIsGhost()Native

  check if the ship is set to be a ghost

• Found in:
  • Vanilla

  boolfunctionIsHostileToSpaceship(SpaceshipReferenceakSpaceship)Native

  Is this spaceship hostile to another spaceship?

• Found in:
  • Vanilla

  boolfunctionIsInCombat()Native

  check if the ship is in combat.

• Found in:
  • Vanilla

  boolfunctionIsInFaction(FactionakFaction)Native

  Checks to see if this spaceship is a member of the specified faction

• Found in:
  • Vanilla

  boolfunctionIsInScene()Native

  check if this spaceship is in a scene

• Found in:
  • Vanilla

  boolfunctionIsLanded()Native

  check if this spaceship is landed

• Found in:
  • Vanilla

  boolfunctionIsProtected(boolabIncludeActors=true)Native

  get if this spaceship is considered protected
  Included actors are anyone in the ship's interior or exterior

• Found in:
  • Vanilla

  boolfunctionIsRampDown()Native

  check if this spaceship's ramp is connected to the surrounding navmesh yet

• Found in:
  • Vanilla

  voidfunctionKill(SpaceshipReferenceakKiller=NONE)Native

  kill this ship with akKiller as the source of the kill

• Found in:
  • Vanilla

  voidfunctionKillEssential(SpaceshipReferenceakKiller=NONE)Native

  kill this ship with akKiller as the source of the kill even if the ship or any on board actors are essential.

• Found in:
  • Vanilla

  voidfunctionKillSilent(SpaceshipReferenceakKiller=NONE)Native

  kill this ship with akKiller as the source of the kill but do not generate story events

• Found in:
  • Vanilla

  voidfunctionModFactionRank(FactionakFaction, intaiAmount)Native

  modifies the faction rank by the given amount

• Found in:
  • Vanilla

  voidfunctionMoveToPackageLocation()Native

  Pop this spaceship to the initial location for a package.

• Found in:
  • Vanilla

  voidfunctionOpenInventory()Native

  Opens this ship's inventory.

• Found in:
  • Vanilla

  voidfunctionLockPowerAllocation(intaiShipPartID, intaiShipPartIndex, boolabLock=true)Native

  Lock the power allocation of a specific part to keep the AI from modifying it
  valid aiShipPartIDs 0 - Weapons, 1 - Engine, 2 - Shields, 3 - Gravdrive, 4 - Generator
  pass -1 to aiShipPartIndex to lock/unlock the power of all the parts of the specified type
  This will also keep the AI from repairing a damaged part

• Found in:
  • Vanilla

  intfunctionPathToReference(ObjectReferenceaTarget, floatafNormalizedSpeed, floatafNormalizedRotationSpeed, floatafTargetRadius=-1, boolabHardRadius=false)Native

  Make the spaceship attempt to path to a reference, latent version
  Note: this method doesn't return until the goal is reached or pathing
  failed or was interrupted (by another request for instance)
  Return values (see Actor for PathingResult properties):
  0 - Success
  1 - Failure
  2 - Stopped
  3 - Cleared
  4 - Timeout

• Found in:
  • Vanilla

  voidfunctionRemoveFromAllFactions()Native

  remove the ship from the all factions

• Found in:
  • Vanilla

  voidfunctionRemoveFromFaction(FactionakFaction)Native

  remove the ship from the given faction

• Found in:
  • Vanilla

  voidfunctionRemovePerk(PerkakPerk)Native

  Removes the specified perk from this spaceship

• Found in:
  • Vanilla

  voidfunctionSendAssaultAlarm()Native

  Has this spaceship behave as if assaulted

• Found in:
  • Vanilla

  voidfunctionSendPiracyAlarm()Native

  Have the ship behave as if pirated

• Found in:
  • Vanilla

  voidfunctionSendSmugglingAlarm(boolabCheckWholeShip=true)Native

  Have this spaceship behave as if they detected the player smuggling

• Found in:
  • Vanilla

  voidfunctionSetAlert(boolabAlerted=true)Native

  Sets the spaceship in an alerted state

• Found in:
  • Vanilla

  voidfunctionSetAttackShipOnSight(boolabAttackOnSight=true)Native

  Sets this ship to be attacked by all other ships on sight

• Found in:
  • Vanilla

  voidfunctionSetAvoidPlayer(boolabAvoid=true)Native

  Tells pathing to avoid the player (which it already does by default) or not (for use in scenes where the player is meant to be an incorporeal observer).

• Found in:
  • Vanilla

  voidfunctionSetCombatStyle(CombatStyleakCombatStyle)Native

  Sets the combatstyle for this spaceship

• Found in:
  • Vanilla

  voidfunctionSetCrimeFaction(FactionakFaction)Native

  Sets the faction this spaceship reports crimes to

• Found in:
  • Vanilla

  voidfunctionSetEssential(boolabEssential)Native

  set if this spaceship is considered essential

• Found in:
  • Vanilla

  voidfunctionSetFactionRank(FactionakFaction, intaiRank)Native

  Sets this spaceship's rank with the specified faction

• Found in:
  • Vanilla

  voidfunctionSetGhost(boolabIsGhost=true)Native

  sets if this spaceship is a ghost

• Found in:
  • Vanilla

  voidfunctionSetNoBleedoutRecovery(boolabBleedoutRecoveryNotAllowed=true)Native

  set the no bleedout recovery status for this ship; pass true to prevent recovery

• Found in:
  • Vanilla

  voidfunctionSetNotShowOnStealthMeter(boolabNotShow=true)Native

  Sets this spaceship to not effect the detection level on the stealth meter if they are not hostile to the player

• Found in:
  • Vanilla

  voidfunctionSetPartPower(intaiShipPartID, intaiShipPartIndex, intaiPower)Native

  Sets the amount of power allocated to a given part
  valid aiShipPartIDs 0 - Weapons, 1 - Engine, 2 - Shields, 3 - Gravdrive, 4 - Generator
  specify -1 for the aiShipPartIndex to set the power of all the parts of the specified type (such as weapons)

• Found in:
  • Vanilla

  voidfunctionSetPlayerResistingArrest()Native

  Sets the player as resisting arrest from this spaceships's faction

• Found in:
  • Vanilla

  voidfunctionSetProtected(boolabProtected)Native

  set if this spaceship is considered protected

• Found in:
  • Vanilla

  voidfunctionShowBarterMenu()Native

  Opens the Barter menu

• Found in:
  • Vanilla

  voidfunctionStartCombat(SpaceshipReferenceakTarget, boolabPreferTarget=false)Native

  start combat with the given target

• Found in:
  • Vanilla

  voidfunctionStopCombat()Native

  stops combat for this spaceship

• Found in:
  • Vanilla

  voidfunctionStopCombatAlarm()Native

  Stops all combat and alarms against this spaceship

• Found in:
  • Vanilla

  voidfunctionTakeOff()Native

  Force this spaceship to takeoff immediately (if it isn't in space)

• Found in:
  • Vanilla

  voidfunctionSetForwardVelocity(floataVelocity)Native

  Set the forward velocity of the ship as a percentage of max speed(0-1)

• Found in:
  • Vanilla

  voidfunctionSetUnconscious(boolaUnconscious)Native

  Set the autopilot of the ship unonscious or conscious

• Found in:
  • Vanilla

  voidfunctionSetIgnoreFriendlyHits(boolaIgnoreFriendlyHits)Native

  Set the ship to ignore friendly hits

• Found in:
  • Vanilla

  floatfunctionGetGravJumpRange()Native

  Gets the spaceships current max grav jump range in light years

• Found in:
  • Vanilla

  KeywordfunctionGetReactorClassKeyword()Native

  Get this ship's reactor class keyword

• Found in:
  • Vanilla

  boolfunctionIsExteriorLoadDoorInaccessible()

  scornett
  Is the ship's exterior load door inaccessible? (Checks the state of the first door found, if there are multiple.)

• Found in:
  • Vanilla

  voidfunctionSetExteriorLoadDoorInaccessible(boolabInaccessible=true)

  scornett
  Sets the ship's exterior load door(s) inaccessible.

• Found in:
  • Vanilla

  boolfunctionIsLandingDeckClear()

  scornett
  Are there any actors on the ship's exterior landing deck? (That is, any actors in the trigger encompassing the landing deck and ramp?) (Checks the state of the first deck found, if there are multiple.)