Faction Script: Difference between revisions

Jump to navigation Jump to search

Faction Script (edit)

Revision as of 04:57, 24 October 2013

81 bytes added ,  24 October 2013
m
→‎Member Functions: Formatting Change
imported>Jog
imported>CraftySentinel
m (→‎Member Functions: Formatting Change)
Line 19: Line 19:


== Member Functions ==
== Member Functions ==
'''bool Function [[CanPayCrimeGold - Faction|CanPayCrimeGold]]()'''
*Checks to see if the player can pay the crime gold for this faction.


'''int Function [[GetCrimeGold - Faction|GetCrimeGold]]()'''
{|class="wikitable" width =100%
*Obtains the amount of gold the player has to pay to this faction for crimes.
!style="text-align:left;"|Function
!style="text-align:left;"|Description
|-
|[[CanPayCrimeGold - Faction|Bool '''CanPayCrimeGold'''()]]
|Checks to see if the player can pay the crime gold for this faction.
|-


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


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


'''int Function [[GetInfamy - Faction|GetInfamy]]()'''
|[[GetCrimeGoldViolent - Faction|Int '''GetCrimeGoldViolent'''()]]
*Obtains the player's current "infamy" with this faction. (Accumulated crime gold)
|Obtains the amount of gold the player has to pay to this faction for violent crimes.
|-


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


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


'''int Function [[GetReaction - Faction|GetReaction]](Faction akOther)'''
|[[GetInfamyViolent - Faction|Int '''GetInfamyViolent'''()]]
*Gets this faction's reaction towards the other faction.
|Obtains the player's current "violent infamy" with this faction. (Accumulated violent crime gold)
|-


'''int Function [[GetStolenItemValueCrime - Faction|GetStolenItemValueCrime]]()'''
|[[GetReaction - Faction|Int '''GetReaction'''(Faction ''akOther'')]]
*Gets the value of all items stolen by the player from this faction that was witnessed.
|Gets this faction's reaction towards the other faction.
|-


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


'''bool Function [[IsFactionInCrimeGroup - Faction|IsFactionInCrimeGroup]](Faction akOther)'''
|[[GetStolenItemValueNoCrime - Faction|Int '''GetStolenItemValueNoCrime'''()]]
*Returns whether the passed in faction is listed in this faction's crime group.
|Gets the value of all items stolen by the player from this faction that was not witnessed.
|-


'''bool Function [[IsPlayerExpelled - Faction|IsPlayerExpelled]]()'''
|[[IsFactionInCrimeGroup - Faction|Bool '''IsFactionInCrimeGroup'''(Faction ''akOther'')]]
*Returns whether the player is expelled from this faction or not.
|Returns whether the passed in faction is listed in this faction's crime group.
|-


'''Function [[ModCrimeGold - Faction|ModCrimeGold]](int aiAmount, bool abViolent)'''
|[[IsPlayerExpelled - Faction|Bool '''IsPlayerExpelled'''()]]
*Modifies the amount of crime gold for this faction, violent or non-violent.
|Returns whether the player is expelled from this faction or not.
|-


'''Function [[ModReaction - Faction|ModReaction]](Faction akOther, int aiAmount)'''
|[[ModCrimeGold - Faction|'''ModCrimeGold'''(Int ''aiAmount'', Bool ''abViolent'')]]
*Modifies this faction's reaction towards the other faction.
|Modifies the amount of crime gold for this faction, violent or non-violent.
|-


'''Function [[PlayerPayCrimeGold - Faction|PlayerPayCrimeGold]](bool abRemoveStolenItems, bool abGoToJail)'''
|[[ModReaction - Faction|'''ModReaction'''(Faction ''akOther'', Int ''aiAmount'')]]
*Has this player pay the crime gold for this faction (and optionally lose their stolen items and go to jail).
|Modifies this faction's reaction towards the other faction.
|-


'''Function [[SendAssaultAlarm - Faction|SendAssaultAlarm]]()'''
|[[PlayerPayCrimeGold - Faction|'''PlayerPayCrimeGold'''(Bool ''abRemoveStolenItems'', Bool ''abGoToJail'')]]
*Finds a nearby actor in this faction and has them behave as if they were assaulted.
|Has this player pay the crime gold for this faction (and optionally lose their stolen items and go to jail).
|-


'''Function [[SendPlayerToJail - Faction|SendPlayerToJail]](bool abRemoveInventory, bool abRealJail)'''
|[[SendAssaultAlarm - Faction|'''SendAssaultAlarm'''()]]
*Sends the player to this faction's jail.
|Finds a nearby actor in this faction and has them behave as if they were assaulted.
|-


'''Function [[SetAlly - Faction|SetAlly]](Faction akOther, bool abSelfIsFriendToOther, bool abOtherIsFriendToSelf)'''
|[[SendPlayerToJail - Faction|'''SendPlayerToJail'''(Bool ''abRemoveInventory'', Bool ''abRealJail'')]]
*Sets the two factions to be friends or allies.
|Sends the player to this faction's jail.
|-


'''Function [[SetCrimeGold - Faction|SetCrimeGold]](int aiGold)'''
|[[SetAlly - Faction|'''SetAlly'''(Faction ''akOther'', Bool ''abSelfIsFriendToOther'', Bool ''abOtherIsFriendToSelf'')]]
*Sets the ''non-violent'' crime gold on this faction.
|Sets the two factions to be friends or allies.
|-


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


'''Function [[SetEnemy - Faction|SetEnemy]](Faction akOther, bool abSelfIsNeutralToOther, bool abOtherIsNeutralToSelf)'''
|[[SetCrimeGoldViolent - Faction|'''SetCrimeGoldViolent'''(Int ''aiGold'')]]
*Sets the two factions to be neutral or enemies.
|Sets the violent crime gold on this faction
|-


'''Function [[SetPlayerEnemy - Faction|SetPlayerEnemy]](bool abIsEnemy)'''
|[[SetEnemy - Faction|'''SetEnemy'''(Faction ''akOther'', Bool ''abSelfIsNeutralToOther'', Bool ''abOtherIsNeutralToSelf'')]]
*Sets or clears the player as an enemy of this faction.
|Sets the two factions to be neutral or enemies.
|-


'''Function [[SetPlayerExpelled - Faction|SetPlayerExpelled]](bool abIsExpelled)'''
|[[SetPlayerEnemy - Faction|'''SetPlayerEnemy'''(Bool ''abIsEnemy'')]]
*Sets or clears the expelled flag for this faction on the player.
|Sets or clears the player as an enemy of this faction.
|-


'''Function [[SetReaction - Faction|SetReaction]](Faction akOther, int aiNewValue)'''
|[[SetPlayerExpelled - Faction|'''SetPlayerExpelled'''(Bool ''abIsExpelled'')]]
*Sets this faction's reaction towards the other faction.
|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 ==
== Events ==
None
None
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/9835"

Navigation menu