The Game Script

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

No properties found.

No events found.

• Found in:
  • Vanilla

  voidfunctionAddAchievement(intaiAchievementID)NativeGlobal

  Adds the specified achievement/trophy to the player's gamer profile.

• Found in:
  • Vanilla

  boolfunctionAddToAvailableCrew(ActorakActor)NativeGlobal

  Adds the specified actor to the player's unassigned crew list

• Found in:
  • Vanilla

  voidfunctionAddPerkPoints(intaiPerkPoints)NativeGlobal

  Adds the specified number of perk points to the player. The result is clamped at 255. This will enable the player to choose additional perks.

• Found in:
  • Vanilla

  voidfunctionAddPlayerOwnedShip(SpaceshipReferencearRef)NativeGlobal

  Add the specified spaceship to the player's owned ships

• Found in:
  • Vanilla

  voidfunctionAdvanceSkill(stringasSkillName, floatafMagnitude)NativeGlobal

  Advances the progress of the provided Skill by the given amount (for the player only).

• Found in:
  • Vanilla

  boolfunctionAreHostileActorsNear()NativeGlobal

  Check if hostile actors are near

• Found in:
  • Vanilla

  voidfunctionClearPrison()NativeGlobal

  Clears all prison variables on the player character so the game will know he is out of prison.

• Found in:
  • Vanilla

  voidfunctionClearTempEffects()NativeGlobal

  Clears all temp effects (such as terrain effects) in the game.

• Found in:
  • Vanilla

  voidfunctionError(stringasMessage)NativeGlobalBetaOnly

  Sends an error and stack trace to the Papyrus script log and the game's warning system.

• Found in:
  • Vanilla

  voidfunctionFadeOutGame(boolabFadingOut, boolabBlackFade, floatafSecsBeforeFade, floatafFadeDuration, boolabStayFaded=false)NativeGlobal

  FadeOutGame uses the in-game Fader menu to fade the game to black, or vice versa.

• Found in:
  • Vanilla

  voidfunctionFastTravel(ObjectReferenceakDestination)NativeGlobal

  Fast-travels the player to the specified ObjectReference's location.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindClosestReferenceOfType(FormarBaseObject, floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds the closest ObjectReference of the given type from the given location and within the given radius.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindRandomReferenceOfType(FormarBaseObject, floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds a random ObjectReference of the given type from the given location and within the given radius.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindClosestReferenceOfAnyTypeInList(FormListarBaseObjects, floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds the closest ObjectReference of any of the types in the list from the given location and within the given radius.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindRandomReferenceOfAnyTypeInList(FormListarBaseObjects, floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds a random ObjectReference of any of the types in the list from the given location and within the given radius.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindClosestReferenceOfTypeFromRef(FormarBaseObject, ObjectReferencearCenter, floatafRadius)Global

  Finds the closest ObjectReference of the given type from the location of the target ObjectReference and within the given radius.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindRandomReferenceOfTypeFromRef(FormarBaseObject, ObjectReferencearCenter, floatafRadius)Global

  Finds a random ObjectReference of the given type from the center of the target ObjectReference and within the given radius.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindClosestReferenceOfAnyTypeInListFromRef(FormListarBaseObjects, ObjectReferencearCenter, floatafRadius)Global

  Finds the closest ObjectReference of any of the types in the list around the target ObjectReference and within the given radius.

• Found in:
  • Vanilla

  ObjectReferencefunctionFindRandomReferenceOfAnyTypeInListFromRef(FormListarBaseObjects, ObjectReferencearCenter, floatafRadius)Global

  Finds a random ObjectReference of any of the types in the list from the given ObjectReference location and within the given radius.

• Found in:
  • Vanilla

  ActorfunctionFindClosestActor(floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds the closest Actor within a given radius of a location.

• Found in:
  • Vanilla

  ActorfunctionFindClosestLivingActor(floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds the closest living actor within a given radius of a location

• Found in:
  • Vanilla

  ActorfunctionFindRandomActor(floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds a random Actor within a given radius of a location.

• Found in:
  • Vanilla

  ActorfunctionFindRandomLivingActor(floatafX, floatafY, floatafZ, floatafRadius)NativeGlobal

  Finds a random living actor within a given radius of a location

• Found in:
  • Vanilla

  ActorfunctionFindClosestActorFromRef(ObjectReferencearCenter, floatafRadius)Global

  Finds the closest Actor within a given radius of a ObjectReference.

• Found in:
  • Vanilla

  ActorfunctionFindClosestLivingActorFromRef(ObjectReferencearCenter, floatafRadius)Global

  Finds the closest living actor within a given radius of a reference

• Found in:
  • Vanilla

  ActorfunctionFindRandomActorFromRef(ObjectReferencearCenter, floatafRadius)Global

  Finds a random Actor within a given radius of a ObjectReference.

• Found in:
  • Vanilla

  ActorfunctionFindRandomLivingActorFromRef(ObjectReferencearCenter, floatafRadius)Global

  Finds a random living actor within a given radius of a reference

• Found in:
  • Vanilla

  voidfunctionForceDisableSSRDirLight(boolabDisableSSR, boolabDisableDirLight)NativeGlobal

  Disable SSR, and/or directional lighting. Note: disable state reset after 240 frames if this function is not continually called.

• Found in:
  • Vanilla

  voidfunctionForceThirdPerson()NativeGlobal

  Force the player to go in to 3rd person camera mode.

• Found in:
  • Vanilla

  voidfunctionForceFirstPerson()NativeGlobal

  Force the player to go in to 1st person camera mode.

• Found in:
  • Vanilla

  intfunctionGetXPForLevel(intauiLevel)NativeGlobal

  Returns the total amount of XP required to obtain the specified level. This is not the amount of xp between two levels.

• Found in:
  • Vanilla

  voidfunctionShowFirstPersonGeometry(boolabShow=true)NativeGlobal

  Show/Hide the players first person geometry.

• Found in:
  • Vanilla

  voidfunctionShowAllMapMarkers()NativeGlobal

  Show all the map markers on the world map.

• Found in:
  • Vanilla

  voidfunctionGameplayAutomatedTestComplete(boolabSuccessful)NativeGlobalDebugOnly

  Tell the code that the gameplay automated test has been completed.

• Found in:
  • Vanilla

  ActorValuefunctionGetAggressionAV()NativeGlobal

  Obtains the Aggression Actor Value.

• Found in:
  • Vanilla

  ActorValuefunctionGetAgilityAV()NativeGlobal

  Obtains the Agility Actor Value.

• Found in:
  • Vanilla

  Location[]functionGetAllLocations()NativeGlobal

  Returns a list of all Locations

• Found in:
  • Vanilla

  Location[]functionGetMatchingLocations(LocationParentLocation=NONE, Keyword[]WantedKeywords=NONE, Keyword[]UnwantedKeywords=NONE, LocationRefType[]WantedRefTypes=NONE, LocationRefType[]UnwantedRefTypes=NONE, boolMustFindAllWantedKeywords=true, boolMustNotFindAnyUnwantedKeywords=true, boolMustFindAllWantedRefTypes=true, boolMustNotFindAnyUnwantedRefTypes=true, intLimitOfLocationsToReturn=0)NativeGlobal

  Returns a list of locations matching the following criteria
  ParentLocation - if not none, returns only locations which have this as a parent location
  WantedKeywords - if not empty, locations must have these keywords
  UnwantedKeywords - if not empty, locations must not have these keywords
  WantedRefTypes - if not empty, locations must have references with these LocationRefTypes
  UnwantedRefTypes - if not empty, locations must not have these RefTypes
  MustFindAllWantedKeywords - if true, locations must have ALL of the keywords. If false, location must have AT LEAST ONE of the keywords
  MustNotFindAnyUnwantedKeywords - if true, locations must not have ANY of the keywords. If false, location must not have ALL of the keywords present at the same time
  MustFindAllWantedRefTypes - if true, locations must have ALL of the RefTypes. If false, location must have AT LEAST ONE of the RefTypes
  MustNotFindAnyUnwantedRefTypes - if true, locations must not have ANY of the RefTypes. If false, location must not have ALL of the RefTypes present at the same time
  LimitOfLocationsToReturn - if > 0, randomly select this many locations to return. If <= 0, return all matching locations

• Found in:
  • Vanilla

  LocationfunctionGetMatchingLocation(LocationParentLocation=NONE, Keyword[]WantedKeywords=NONE, Keyword[]UnwantedKeywords=NONE, LocationRefType[]WantedRefTypes=NONE, LocationRefType[]UnwantedRefTypes=NONE, boolMustFindAllWantedKeywords=true, boolMustNotFindAnyUnwantedKeywords=true, boolMustFindAllWantedRefTypes=true, boolMustNotFindAnyUnwantedRefTypes=true)Global
• Found in:
  • Vanilla

  floatfunctionGetCameraHeadingAngle(ObjectReferenceakTarget)NativeGlobal

  Gets the angle between the camera's heading and the target object in degrees - in the range from -180 to 180

• Found in:
  • Vanilla

  MiscObjectfunctionGetCaps()Global

  Obtains the MiscObject representing caps, the basic unit of money in the game.

• Found in:
  • Vanilla

  MiscObjectfunctionGetCredits()Global
• Found in:
  • Vanilla

  ActorValuefunctionGetCharismaAV()NativeGlobal

  Obtains the Charisma Actor Value.

• Found in:
  • Vanilla

  ActorValuefunctionGetConfidenceAV()NativeGlobal

  Obtains the Confidence Actor Value.

• Found in:
  • Vanilla

  intfunctionGetDieRoll(intMinResult=1, intNumberOfSides=100, intDebugDieRoll=-1)Global

  Get a die roll result

• Found in:
  • Vanilla

  boolfunctionGetDieRollSuccess(intChance, intMinResult=1, intNumberOfSides=100, intDebugDieRoll=-1, intForcedDieRoll=-1)Global

  Get if a die roll result was a success

• Found in:
  • Vanilla

  intfunctionGetDifficulty()NativeGlobal

  Returns the game's current difficulty.

• Found in:
  • Vanilla

  ActorValuefunctionGetEnduranceAV()NativeGlobal

  Obtains the Endurance Actor Actor Value.

• Found in:
  • Vanilla

  FormfunctionGetForm(intaiFormID)NativeGlobal

  Obtains the form specified by its form ID number.

• Found in:
  • Vanilla

  FormfunctionGetFormFromFile(intaiFormID, stringasFilename)NativeGlobal

  Obtains the form specified by its form ID number which originated in the specified file. The ID for a form changes based on the load order of the file it loaded from. So a form which shows up as 0101ABCD in the editor may show up as 0401ABCD in game depending on how many other files load before it. This function lets you blindly grab a form based on the lower bytes of its ID and the expected file which created the form.

• Found in:
  • Vanilla

  floatfunctionGetGameSettingFloat(stringasGameSetting)NativeGlobal

  Obtains the value of the specified float game setting

• Found in:
  • Vanilla

  intfunctionGetGameSettingInt(stringasGameSetting)NativeGlobal

  Obtains the value of the specified int game setting

• Found in:
  • Vanilla

  stringfunctionGetGameSettingString(stringasGameSetting)NativeGlobal

  Obtains the value of the specified string game setting

• Found in:
  • Vanilla

  intfunctionGetGameSettingUInt(stringasGameSetting)NativeGlobal
• Found in:
  • Vanilla

  boolfunctionGetGameSettingBool(stringasGameSetting)NativeGlobal
• Found in:
  • Vanilla

  ActorValuefunctionGetHealthAV()NativeGlobal

  Obtains the Health Actor Value.

• Found in:
  • Vanilla

  ActorValuefunctionGetIntelligenceAV()NativeGlobal

  Obtains the Intelligence Actor Value.

• Found in:
  • Vanilla

  ActorValuefunctionGetLuckAV()NativeGlobal

  Obtains the Luck Actor Value.

• Found in:
  • Vanilla

  ActorValuefunctionGetInvulnerableAV()NativeGlobal

  Get the Invulnerable Actor Value

• Found in:
  • Vanilla

  ActorValuefunctionGetPerceptionAV()NativeGlobal

  Obtains the Perception Actor Value.

• Found in:
  • Vanilla

  ActorfunctionGetPlayer()NativeGlobal

  Obtains the actor representing the player.

• Found in:
  • Vanilla

  Quest[]functionGetPlayerActiveQuests()NativeGlobal

  Returns a list of quests that are active on the player

• Found in:
  • Vanilla

  int[]functionGetPlayerActiveDialogueUnsaidInfo()NativeGlobal

  Returns an array of how many unsaid topics are tied to each dialogue option in the active conversation

• Found in:
  • Vanilla

  Actor[]functionGetPlayerFollowers()NativeGlobal

  Returns an array of the player's followers.

• Found in:
  • Vanilla

  intfunctionGetPlayerLevel()Global

  Obtains the player's current level.

• Found in:
  • Vanilla

  ObjectReferencefunctionGetPlayerGrabbedRef()NativeGlobal

  Obtains the reference the player is currently grabbing.

• Found in:
  • Vanilla

  floatfunctionGetPlayerRadioFrequency()NativeGlobal

  Returns the current frequency of the player's radio, which may or may not be turned to any particular station.

• Found in:
  • Vanilla

  ActorfunctionGetPlayersLastRiddenHorse()NativeGlobal

  Obtains the horse last ridden by the player.

• Found in:
  • Vanilla

  floatfunctionGetRealHoursPassed()NativeGlobal

  Returns the number of real-life hours the player has been playing.

• Found in:
  • Vanilla

  ActorValuefunctionGetSuspiciousAV()NativeGlobal

  Obtains the Suspicious Actor Value.

• Found in:
  • Vanilla

  ActorValuefunctionGetStrengthAV()NativeGlobal

  Obtains the Strength Actor Value.

• Found in:
  • Vanilla

  voidfunctionGivePlayerCaps(intnCaps)Global

  Gives the player the specified number of caps.

• Found in:
  • Vanilla

  voidfunctionHideContrabandScanWarning(boolabSkipCompletionAnim=false, boolabWasDetectionEvaded=false)NativeGlobal

  Hides the Contraband Scan Warning, skipping or completing the scan as a success or failure.
  If abSkipCompletionAnim is true, abWasDetectionEvaded will be ignored.

• Found in:
  • Vanilla

  voidfunctionHideHudMenus()NativeGlobal

  Hides the hud and spaceship hud menus.

• Found in:
  • Vanilla

  voidfunctionRemovePlayerCaps(intnCaps)Global

  Removes the specified number of caps from the player (destroyed, not moved to a container)

• Found in:
  • Vanilla

  voidfunctionIncrementSkill(ActorValueakActorValue, intaiCount=1)NativeGlobal

  Advances the provided Skill by the one point (for the player only).

• Found in:
  • Vanilla

  voidfunctionIncrementStat(stringasStatName, intaiModAmount=1)NativeGlobal

  Modifies the specified misc stat by the given amount.

• Found in:
  • Vanilla

  boolfunctionIsActivateControlsEnabled()NativeGlobal

  Checks to see if activation controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsAutomatedTestControllingPlayerInProgress()NativeGlobalDebugOnly

  Is there an automated test controlling the player (bot) running currently?

• Found in:
  • Vanilla

  boolfunctionIsVATSControlsEnabled()NativeGlobal

  Checks to see if VATS is currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsVATSPlaybackActive()NativeGlobal

  Checks to see if VATS playback is active or not.

• Found in:
  • Vanilla

  boolfunctionIsCamSwitchControlsEnabled()NativeGlobal

  Checks to see if camera switch controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsFarTravelControlsEnabled()NativeGlobal

  Is ship far travel enabled?

• Found in:
  • Vanilla

  boolfunctionIsFastTravelControlsEnabled()NativeGlobal

  Checks to see whether or not fast travel is allowed by script.

• Found in:
  • Vanilla

  boolfunctionIsFastTravelEnabled()NativeGlobal

  Checks to see if fast travel is currently allowed or not.

• Found in:
  • Vanilla

  boolfunctionIsFavoritesControlsEnabled()NativeGlobal

  Checks to see if favorites controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsGravJumpControlsEnabled()NativeGlobal

  Is ship grav jump enabled?

• Found in:
  • Vanilla

  boolfunctionIsGuardPursuingPlayer()NativeGlobal

  are any guards pursuing the player for crime?

• Found in:
  • Vanilla

  boolfunctionIsTakeoffControlsEnabled()NativeGlobal

  Is ship takeoff enabled?

• Found in:
  • Vanilla

  boolfunctionIsFightingControlsEnabled()NativeGlobal

  Checks to see if fighting controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsJournalControlsEnabled()NativeGlobal

  Checks to see if journal menu controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsJumpingControlsEnabled()NativeGlobal

  Checks to see if jumping controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsLookingControlsEnabled()NativeGlobal

  Checks to see if looking controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsMenuControlsEnabled()NativeGlobal

  Checks to see if menu controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsMovementControlsEnabled()NativeGlobal

  Checks to see if movement controls are currently enabled or not.

• Found in:
  • Vanilla

  boolfunctionIsPluginInstalled(stringasName)NativeGlobal

  Returns whether the specified plugin is installed and activated or not. Note that it needs the extension as well (esp or esm).

• Found in:
  • Vanilla

  boolfunctionIsPlayerInDialogue()NativeGlobal

  Is the player currently considered in dialogue?

• Found in:
  • Vanilla

  boolfunctionIsPlayerInMessageBox()NativeGlobal

  Is the player currently being displayed a message box?

• Found in:
  • Vanilla

  boolfunctionIsPlayerInRadioRange(floatafFrequency)NativeGlobal

  Returns whether the player is within the outer radius of a transmitter using the given frequency.

• Found in:
  • Vanilla

  boolfunctionIsPlayerListening(floatafFrequency)NativeGlobal

  Returns whether the player actively listening to a transmitter that uses the given frequency.

• Found in:
  • Vanilla

  boolfunctionIsPlayerLoitering()NativeGlobal

  Is the player loitering

• Found in:
  • Vanilla

  boolfunctionIsPlayerSpaceshipOwner(SpaceshipReferencearRef)NativeGlobal

  Is the player an owner of this spaceship reference

• Found in:
  • Vanilla

  boolfunctionIsPlayerRadioOn()NativeGlobal

  Returns whether the player's radio is currently on or not.

• Found in:
  • Vanilla

  boolfunctionIsResearchComplete(ResearchProjectakResearchProject)NativeGlobal

  has the player completed this research project

• Found in:
  • Vanilla

  boolfunctionIsSneakingControlsEnabled()NativeGlobal

  Checks to see if sneaking controls are currently enabled or not.

• Found in:
  • Vanilla

  voidfunctionPassTime(intaiHours)NativeGlobal

  Warning: This function is not working as intended. Instead of passing the specified number of hours, this function always passes 100 in-game hours. The following documentation describes the intended functionality, not the actual behavior! Consider incrementing the "GameHour" Global as a replacement.

  Passes the specified number of hours as if the Player used the SitWaitMenu. This runs full updates of AI so if the number of hours is large enough, this can produce a noticeable hitch best hidden behind a menu.

• Found in:
  • Vanilla

  voidfunctionPlayBink(stringasFileName, boolabInterruptible=false, boolabMuteAudio=true, boolabMuteMusic=true, boolabLetterbox=true, boolabIsNewGameBink=false)NativeGlobal

  Plays the specified bink file.

• Found in:
  • Vanilla

  voidfunctionPlayBinkNoWait(stringasFileName, boolabInterruptible=false, boolabMuteAudio=true, boolabMuteMusic=true, boolabLetterbox=true, boolabIsNewGameBink=false, boolaPlayDuringLoadingScreen=false)NativeGlobal

  Plays a bink video, use with care!

• Found in:
  • Vanilla

  voidfunctionPrecacheCharGen()NativeGlobal

  Precaches all the data used by character gen to avoid hitches with file i/o.

• Found in:
  • Vanilla

  voidfunctionPrecacheCharGenClear()NativeGlobal

  Clears all the previously cached data used by character gen.

• Found in:
  • Vanilla

  boolfunctionPopPlayerTo(ObjectReferenceakTarget, floatafXOffset=0.0, floatafYOffset=0.0, floatafZOffset=0.0, boolabMatchRotation=true, boolabCheckForCollision=false)NativeGlobal

  Pops the player to the location of the target without any load or screen fade. Note that the target reference must be in the same cell as the player.
  If you have to move the player to a reference in another cell, use MoveTo instead.

• Found in:
  • Vanilla

  intfunctionQueryStat(stringasStat)NativeGlobal

  Queries the value of the specified misc stat.

• Found in:
  • Vanilla

  voidfunctionQuitToMainMenu()NativeGlobal

  Force the game back to the main menu.

• Found in:
  • Vanilla

  voidfunctionRemoveFromAvailableCrew(ActorakActor)NativeGlobal

  Removes the specified actor from the player's list of available crew members.

• Found in:
  • Vanilla

  boolfunctionRemovePlayerOwnedShip(SpaceshipReferencearRef)NativeGlobal

  Remove the specified spaceship from the player's owned ships

• Found in:
  • Vanilla

  voidfunctionRequestAutoSave()NativeGlobal

  Requests an auto-save to be made. Note that the save may take a moment or so to happen.

• Found in:
  • Vanilla

  voidfunctionRequestDialogueSkip()NativeGlobal

  Request that the dialogue menu skips the current line of dialogue

• Found in:
  • Vanilla

  voidfunctionRequestDialogueExit()NativeGlobal

  Request that the dialogue menu exits if possible

• Found in:
  • Vanilla

  voidfunctionRequestDialogueSelect(intaiIndex)NativeGlobal

  Request to select a dialogue option

• Found in:
  • Vanilla

  voidfunctionRequestGameplayBotState(ObjectReferencearRef, intaiState)NativeGlobal

  Request to start a state with the target refernece

• Found in:
  • Vanilla

  voidfunctionRequestMessageBoxSelect(intaiIndex)NativeGlobal

  Request to select a messagebox option

• Found in:
  • Vanilla

  voidfunctionRequestHUDRolloverRefresh()NativeGlobal

  Request that the HUD's rollover refresh itself

• Found in:
  • Vanilla

  voidfunctionRequestModel(stringasModelName)NativeGlobal

  Requests the specified model (usually because we're going to need it soon).

• Found in:
  • Vanilla

  voidfunctionRequestSave()NativeGlobal

  Requests a normal save to be made. Note that the save may take a moment or so to happen.

• Found in:
  • Vanilla

  voidfunctionRequestSaveByName(stringasSaveName)NativeGlobalDebugOnly

  Request that a save with a specific name be made

• Found in:
  • Vanilla

  voidfunctionCreateStarbornGame()NativeGlobal

  Request that the game resets into NG+ with the current player character

• Found in:
  • Vanilla

  voidfunctionRewardPlayerXP(intauiXPAmount, boolabDirect=false)NativeGlobal

  Rewards the player with a certain amount of XP, optionally bypassing any XP modifiers.

• Found in:
  • Vanilla

  voidfunctionServeTime()NativeGlobal

  Has the player serve their jail time.

• Found in:
  • Vanilla

  voidfunctionSetCameraTarget(ActorarTarget)NativeGlobal

  Sets the current target for the player's camera.

• Found in:
  • Vanilla

  voidfunctionSetCharGenHUDMode(intaiCGHUDMode)NativeGlobal

  Sets or clears CharGen-specific HUD modes.

• Found in:
  • Vanilla

  voidfunctionSetHandscannerDistortionLevel(intaLevel)NativeGlobal

  Sets the distortion level on the handscanner (0-3)

• Found in:
  • Vanilla

  voidfunctionSetInChargen(boolabDisableSaving, boolabDisableWaiting, boolabShowControlsDisabledMessage)NativeGlobal

  Tells the game that we're in the initial "character generation" quest. Used to enable / disable certain functionality, e.g. enable tutorials, disable saving, etc.

• Found in:
  • Vanilla

  voidfunctionSetPlayerAIDriven(boolabAIDriven=true)NativeGlobal

  Set the state of the player as AI driven to allow for the player run packages

• Found in:
  • Vanilla

  voidfunctionSetPlayerOnElevator(boolabOnElevator=true)NativeGlobal

  Set the state of the player on an Elevator to allow for npc's to pick up player on elevator packages or other behaviors

• Found in:
  • Vanilla

  boolfunctionTrySetPlayerHomeSpaceShip(ObjectReferenceakHomeShip)NativeGlobal

  Attempts to set the player's home ship

• Found in:
  • Vanilla

  SpaceshipReferencefunctionGetPlayerHomeSpaceShip()NativeGlobal

  Gets the home ship of the player

• Found in:
  • Vanilla

  SpaceshipReference[]functionGetPlayerOwnedShips()NativeGlobal

  Gets spaceships the player owns

• Found in:
  • Vanilla

  voidfunctionSetPlayerRadioFrequency(floatafFrequency)NativeGlobal

  Sets the player's radio's current frequency. It is not recommended that you do this while the player is messing with the pipboy.

• Found in:
  • Vanilla

  voidfunctionSetPlayerReportCrime(boolabReportCrime=true)NativeGlobal

  Set the state of the player as an actor who commits crimes

• Found in:
  • Vanilla

  voidfunctionSetSittingRotation(floatafValue)NativeGlobal

  Set the sitting offset for the players camera.

• Found in:
  • Vanilla

  voidfunctionShakeCamera(ObjectReferenceakSource=NONE, floatafStrength=0.5, floatafDuration=0.0)NativeGlobal

  Shakes the camera from the specified object's location, with the specified strength. The optional duration can be used to define how long to shake the camera. If no duration is provided then the fCameraShakeTime game setting will be used for duration.

• Found in:
  • Vanilla

  voidfunctionShakeController(floatafSmallMotorStrength, floatafBigMotorStreangth, floatafDuration)NativeGlobal

  Shakes the controller with the specified strength, for the specified length of time.

• Found in:
  • Vanilla

  voidfunctionSetLocalTime(floatafLocalTime)NativeGlobal

  Rotates the current planet such that the local time will match the specified time

• Found in:
  • Vanilla

  floatfunctionGetLocalTime()NativeGlobal

  Get the local time in normalized 24-hour day scale for this planet

• Found in:
  • Vanilla

  voidfunctionShowContrabandScanWarning(intaiChanceToEvadeDetection, boolabScanInProgress=false)NativeGlobal

  Shows the Contraband Scan Warning.
  aiChanceToEvadeDetection: an integer representing the percent to evade detection.
  abScanInProgress: a boolean that specifies whether a security scan is in progress.

• Found in:
  • Vanilla

  voidfunctionShowCustomWatchAlert(stringaAnimName)NativeGlobal

  Shows a custom watch animation on the HUD watch

• Found in:
  • Vanilla

  voidfunctionShowFatigueWarningOnHUD()NativeGlobal

  Causes the fatigue warning to show on the HUD menu.

• Found in:
  • Vanilla

  voidfunctionShowMissionBoardMenu(KeywordakFilterByKeyword=NONE, intiFaction=-1)NativeGlobal

  Opens the mission board menu with an optional keyword parameter to filter the list

• Found in:
  • Vanilla

  voidfunctionShowRaceMenu(ObjectReferenceakMenuTarget=NONE, intuiMode=0, ObjectReferenceakMenuSpouseFemale=NONE, ObjectReferenceakMenuSpouseMale=NONE, ObjectReferenceakVendor=NONE)NativeGlobal

  Shows the race/sex change menu.

• Found in:
  • Vanilla

  voidfunctionShowGalaxyStarMapMenu()NativeGlobal

  Shows the Galaxy Star Map menu.

• Found in:
  • Vanilla

  voidfunctionShowTitleSequenceMenu()NativeGlobal

  Start the title sequence menu.

• Found in:
  • Vanilla

  voidfunctionHideTitleSequenceMenu()NativeGlobal

  Kill the title sequence menu.

• Found in:
  • Vanilla

  voidfunctionStartTitleSequence(stringasSequenceName)NativeGlobal

  Run a given animation in the title menu.

• Found in:
  • Vanilla

  voidfunctionTriggerScreenBlood(intaiValue)NativeGlobal

  Trigger on-screen blood splatter.

• Found in:
  • Vanilla

  voidfunctionPlayEventCamera(CameraShotakCamera, ObjectReferenceakRef)NativeGlobal

  Plays an event camera attached to the given reference.

• Found in:
  • Vanilla

  voidfunctionStartDialogueCameraOrCenterOnTarget(ObjectReferenceakCameraTarget=NONE)NativeGlobal

  Start dialogue cameras or swing first person camera to the target - or current dialogue target if no target is passed.

• Found in:
  • Vanilla

  voidfunctionStopDialogueCamera(boolabConsiderResume=false, boolabSwitchingTo1stP=false)NativeGlobal

  Stops all dialogue cameras.

• Found in:
  • Vanilla

  voidfunctionTurnPlayerRadioOn(boolabRadioOn=true)NativeGlobal

  Turns the player's radio on and off. It is not recommended that you do this while the player is messing with the pipboy.

• Found in:
  • Vanilla

  boolfunctionUsingGamepad()NativeGlobal

  Returns true if we're using a gamepad.

• Found in:
  • Vanilla

  voidfunctionWarning(stringasMessage)NativeGlobalBetaOnly

  Sends a warning to the Papyrus script log and the game's warning system.