Editing Faction Script

'''Extends:''' [[Form Script]]

Script for the manipulation of faction base objects.

== Definition ==
<syntaxhighlight lang="papyrus">
ScriptName Faction extends Form
</syntaxhighlight>

== Properties ==
None

== Global Functions ==
None

== Member Functions ==

:'''Bool [[CanPayCrimeGold - Faction|CanPayCrimeGold]]()'''
:*Checks to see if the player can pay the crime gold for this faction.

:'''Int [[GetCrimeGold - Faction|GetCrimeGold]]()'''
:*Obtains the amount of gold the player has to pay to this faction for crimes.

:'''Int [[GetCrimeGoldNonViolent - Faction|GetCrimeGoldNonViolent]]()'''
:*Obtains the amount of gold the player has to pay to this faction for non-violent crimes.

:'''Int [[GetCrimeGoldViolent - Faction|GetCrimeGoldViolent]]()'''
:*Obtains the amount of gold the player has to pay to this faction for violent crimes.

:'''Int [[GetInfamy - Faction|GetInfamy]]()'''
:*Obtains the player's current "infamy" with this faction. (Accumulated crime gold)

:'''Int [[GetInfamyNonViolent - Faction|GetInfamyNonViolent]]()'''
:*Obtains the player's current "non-violent infamy" with this faction. (Accumulated non-violent crime gold)

:'''Int [[GetInfamyViolent - Faction|GetInfamyViolent]]()'''
:*Obtains the player's current "violent infamy" with this faction. (Accumulated violent crime gold)

:'''Int [[GetReaction - Faction|GetReaction]](Faction ''akOther'')'''
:*Gets this faction's reaction towards the other faction.

:'''Int [[GetStolenItemValueCrime - Faction|GetStolenItemValueCrime]]()'''
:*Gets the value of all items stolen by the player from this faction that was witnessed.

:'''Int [[GetStolenItemValueNoCrime - Faction|GetStolenItemValueNoCrime]]()'''
:*Gets the value of all items stolen by the player from this faction that was not witnessed.

:'''Bool [[IsFactionInCrimeGroup - Faction|IsFactionInCrimeGroup]](Faction ''akOther'')'''
:*Returns whether the passed in faction is listed in this faction's crime group.

:'''Bool [[IsPlayerExpelled - Faction|IsPlayerExpelled]]()'''
:*Returns whether the player is expelled from this faction or not.

:'''[[ModCrimeGold - Faction|ModCrimeGold]](Int ''aiAmount'', Bool ''abViolent'')'''
:*Modifies the amount of crime gold for this faction, violent or non-violent.

:'''[[ModReaction - Faction|ModReaction]](Faction ''akOther'', Int ''aiAmount'')'''
:*Modifies this faction's reaction towards the other faction.

:'''[[PlayerPayCrimeGold - Faction|PlayerPayCrimeGold]](Bool ''abRemoveStolenItems'', Bool ''abGoToJail'')'''
:*Has this player pay the crime gold for this faction (and optionally lose their stolen items and go to jail).

:'''[[SendAssaultAlarm - Faction|SendAssaultAlarm]]()'''
:*Finds a nearby actor in this faction and has them behave as if they were assaulted.

:'''[[SendPlayerToJail - Faction|SendPlayerToJail]](Bool ''abRemoveInventory'', Bool ''abRealJail'')'''
:*Sends the player to this faction's jail.

:'''[[SetAlly - Faction|SetAlly(]]Faction ''akOther'', Bool ''abSelfIsFriendToOther'', Bool ''abOtherIsFriendToSelf'')'''
:*Sets the two factions to be friends or allies.

:'''[[SetCrimeGold - Faction|SetCrimeGold]](Int ''aiGold'')'''
:*Sets the ''non-violent'' crime gold on this faction.

:'''[[SetCrimeGoldViolent - Faction|SetCrimeGoldViolent]](Int ''aiGold'')'''
:*Sets the violent crime gold on this faction

:'''[[SetEnemy - Faction|SetEnemy]](Faction ''akOther'', Bool ''abSelfIsNeutralToOther'', Bool ''abOtherIsNeutralToSelf'')'''
:*Sets the two factions to be neutral or enemies.

:'''[[SetPlayerEnemy - Faction|SetPlayerEnemy]](Bool ''abIsEnemy'')'''
:*Sets or clears the player as an enemy of this faction.

:'''[[SetPlayerExpelled - Faction|SetPlayerExpelled]](Bool ''abIsExpelled'')'''
:*Sets or clears the expelled flag for this faction on the player.

:'''[[SetReaction - Faction|SetReaction]](Faction ''akOther'', Int ''aiNewValue'')'''
:*Sets this faction's reaction towards the other faction.


== Events ==
None


[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]