Faction Script

Extends: Form Script
Editor: Faction

Script for the manipulation of faction base objects.

Definition

ScriptName Faction extends Form Native Hidden

Properties

None

Global Functions

None

Member Functions

• bool Function CanPayCrimeGold()
  • Checks to see if the player can pay the crime gold for this faction.
• int Function GetCrimeGold()
  • Obtains the amount of gold the player has to pay to this faction for crimes.
• int Function GetCrimeGoldNonViolent()
  • Obtains the amount of gold the player has to pay to this faction for non-violent crimes.
• int Function GetCrimeGoldViolent()
  • Obtains the amount of gold the player has to pay to this faction for violent crimes.
• int Function GetFactionReaction(Actor akOther)
  • Checks this faction against an actor's set of factions.
• int Function GetInfamy()
  • Obtains the player's current "infamy" with this faction. (Accumulated crime gold)
• int Function GetInfamyNonViolent()
  • Obtains the player's current "non-violent infamy" with this faction. (Accumulated non-violent crime gold)
• int Function GetInfamyViolent()
  • Obtains the player's current "violent infamy" with this faction. (Accumulated violent crime gold)
• int Function GetStolenItemValueCrime()
  • Gets the value of all items stolen by the player from this faction that was witnessed.
• int Function GetStolenItemValueNoCrime()
  • Gets the value of all items stolen by the player from this faction that was not witnessed.
• bool Function IsFactionInCrimeGroup(Faction akOther)
  • Returns whether the passed in faction is listed in this faction's crime group.
• bool Function IsPlayerEnemy()
  • Returns whether the player is an enemy of this faction or not.
• bool Function IsPlayerExpelled()
  • Returns whether the player is expelled from this faction or not.
• Function ModCrimeGold(int aiAmount, bool abViolent)
  • Modifies the amount of crime gold for this faction, violent or non-violent.
• Function 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).
• Function SendAssaultAlarm()
  • Finds a nearby actor in this faction and has them behave as if they were assaulted.
• Function SendPlayerToJail(bool abRemoveInventory, bool abRealJail)
  • Sends the player to this faction's jail.
• Function SetAlly(Faction akOther, bool abSelfIsFriendToOther, bool abOtherIsFriendToSelf)
  • Sets the two factions to be friends or allies.
• Function SetCrimeGold(int aiGold)
  • Sets the non-violent crime gold on this faction.
• Function SetCrimeGoldViolent(int aiGold)
  • Sets the violent crime gold on this faction
• Function SetEnemy(Faction akOther, bool abSelfIsNeutralToOther, bool abOtherIsNeutralToSelf)
  • Sets the two factions to be neutral or enemies.
• Function SetPlayerEnemy(bool abIsEnemy)
  • Sets or clears the player as an enemy of this faction.
• Function SetPlayerExpelled(bool abIsExpelled)
  • Sets or clears the expelled flag for this faction on the player.

Events

None