Background for Fallout 4

The Faction Script

    The Faction script is a part of Fallout 4’s Papyrus scripting ecosystem. It is included with the base game.

    For this script, the Papyrus index knows about:

    • 23 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Structs

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

      Properties

      No properties found.

        Events

          No events found.

        Functions

        • boolfunctionCanPayCrimeGold()Native

          Checks to see if the player can pay the crime gold for this faction.

        • intfunctionGetCrimeGold()Native

          Get the amount of crime gold on this faction that the player needs to pay.

        • intfunctionGetCrimeGoldNonViolent()Native

          Get the amount of crime gold on this faction that the player needs to pay for non-violent crimes.

        • intfunctionGetCrimeGoldViolent()Native

          Get the amount of crime gold on this faction that the player needs to pay for violent crimes.

        • intfunctionGetInfamy()Native

          Get the amount of infamy (accumulated crime gold) the player has with this faction.

        • intfunctionGetInfamyNonViolent()Native

          Get the amount of non-violent infamy (accumulated non-violent crime gold) the player has with this faction.

        • intfunctionGetInfamyViolent()Native

          Get the amount of violent infamy (accumulated violent crime gold) the player has with this faction.

        • intfunctionGetFactionReaction(ActorakOther)Native

          Get the faction-based reaction between this faction and an actor.

        • intfunctionGetStolenItemValueCrime()Native

          Get the value of all items stolen by the player from this faction that was witnessed.

        • intfunctionGetStolenItemValueNoCrime()Native

          Get the value of all items stolen by the player from this faction that was not witnessed.

        • boolfunctionIsFactionInCrimeGroup(FactionakOther)Native

          Checks to see if the passed in faction is in this faction's crime group.

        • boolfunctionIsPlayerEnemy()Native

          Checks to see if the player is an enemy of this faction or not.

          This is the same flag that gets set on a faction when the player commits a crime against it, which allows a faction to attack the player even if the player is an ally of that faction.

          The flag is automatically cleared (whether set by script or code) after 24 hours.

        • boolfunctionIsPlayerExpelled()Native

          Checks to see if the player is expelled from this faction.

        • voidfunctionModCrimeGold(intaiAmount, boolabViolent=false)Native

          Modifies the amount of crime gold on this faction.

        • voidfunctionPlayerPayCrimeGold(boolabRemoveStolenItems=true, boolabGoToJail=true)Native

          Has the player pay the crime gold on this faction, possibly removing any stolen items in their inventory and sending them to jail.

        • voidfunctionSendAssaultAlarm()Native

          Finds a nearby member of this faction and tells them to behave as if they were assaulted.

        • voidfunctionSendPlayerToJail(boolabRemoveInventory=true, boolabRealJail=true)Native

          Sends the player to jail, optionally removing his inventory, and sending him to "real" jail.

        • voidfunctionSetAlly(FactionakOther, boolabSelfIsFriendToOther=false, boolabOtherIsFriendToSelf=false)Native

          Sets the two factions to be friend or allies of eachother.

        • voidfunctionSetCrimeGold(intaiGold)Native

          Set the amount of non-violent crime gold on this faction.

        • voidfunctionSetCrimeGoldViolent(intaiGold)Native

          Set the amount of violent crime gold on this faction.

        • voidfunctionSetEnemy(FactionakOther, boolabSelfIsNeutralToOther=false, boolabOtherIsNeutralToSelf=false)Native

          Sets the two factions to be neutral or enemies of each other.

        • voidfunctionSetPlayerEnemy(boolabIsEnemy=true)Native

          Sets or clears the enemy flag from this faction for the player.

        • voidfunctionSetPlayerExpelled(boolabIsExpelled=true)Native

          Sets or clears the expelled flag from this faction for the player.

        Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.