Faction Script
Revision as of 04:57, 24 October 2013 by imported>CraftySentinel (→Member Functions: Formatting Change)
Extends: Form Script
Script for the manipulation of faction base objects.
Definition
ScriptName Faction extends FormProperties
None
Global Functions
None
Member Functions
| Function | Description |
|---|---|
| Bool CanPayCrimeGold() | Checks to see if the player can pay the crime gold for this faction. |
| Int GetCrimeGold() | Obtains the amount of gold the player has to pay to this faction for crimes. |
| Int GetCrimeGoldNonViolent() | Obtains the amount of gold the player has to pay to this faction for non-violent crimes. |
| Int GetCrimeGoldViolent() | Obtains the amount of gold the player has to pay to this faction for violent crimes. |
| Int GetInfamy() | Obtains the player's current "infamy" with this faction. (Accumulated crime gold) |
| Int GetInfamyNonViolent() | Obtains the player's current "non-violent infamy" with this faction. (Accumulated non-violent crime gold) |
| Int GetInfamyViolent() | Obtains the player's current "violent infamy" with this faction. (Accumulated violent crime gold) |
| Int GetReaction(Faction akOther) | Gets this faction's reaction towards the other faction. |
| Int GetStolenItemValueCrime() | Gets the value of all items stolen by the player from this faction that was witnessed. |
| Int GetStolenItemValueNoCrime() | Gets the value of all items stolen by the player from this faction that was not witnessed. |
| Bool IsFactionInCrimeGroup(Faction akOther) | Returns whether the passed in faction is listed in this faction's crime group. |
| Bool IsPlayerExpelled() | Returns whether the player is expelled from this faction or not. |
| ModCrimeGold(Int aiAmount, Bool abViolent) | Modifies the amount of crime gold for this faction, violent or non-violent. |
| ModReaction(Faction akOther, Int aiAmount) | Modifies this faction's reaction towards the other 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() | Finds a nearby actor in this faction and has them behave as if they were assaulted. |
| SendPlayerToJail(Bool abRemoveInventory, Bool abRealJail) | Sends the player to this faction's jail. |
| SetAlly(Faction akOther, Bool abSelfIsFriendToOther, Bool abOtherIsFriendToSelf) | Sets the two factions to be friends or allies. |
| SetCrimeGold(Int aiGold) | Sets the non-violent crime gold on this faction. |
| SetCrimeGoldViolent(Int aiGold) | Sets the violent crime gold on this faction |
| SetEnemy(Faction akOther, Bool abSelfIsNeutralToOther, Bool abOtherIsNeutralToSelf) | Sets the two factions to be neutral or enemies. |
| SetPlayerEnemy(Bool abIsEnemy) | Sets or clears the player as an enemy of this faction. |
| SetPlayerExpelled(Bool abIsExpelled) | Sets or clears the expelled flag for this faction on the player. |
| SetReaction(Faction akOther, Int aiNewValue) | Sets this faction's reaction towards the other faction. |
Events
None