Table of Contents

Class FactionScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Faction.psc.

public static class FactionScript
Inheritance
FactionScript
Inherited Members

Fields

kFaction_CanBeOwner 

public const int kFaction_CanBeOwner = 8192

Field Value

int

kFaction_CrimeGoldDefaults 

public const int kFaction_CrimeGoldDefaults = 1024

Field Value

int

kFaction_HiddenFromNPC 

public const int kFaction_HiddenFromNPC = 1

Field Value

int

kFaction_IgnoreAssault 

public const int kFaction_IgnoreAssault = 64

Field Value

int

kFaction_IgnoreMurder 

public const int kFaction_IgnoreMurder = 32

Field Value

int

kFaction_IgnorePickpocket 

public const int kFaction_IgnorePickpocket = 2048

Field Value

int

kFaction_IgnoreStealing 

public const int kFaction_IgnoreStealing = 128

Field Value

int

kFaction_IgnoreTrespass 

public const int kFaction_IgnoreTrespass = 256

Field Value

int

kFaction_IgnoreWerewolf 

public const int kFaction_IgnoreWerewolf = 16384

Field Value

int

kFaction_NoReportCrime 

public const int kFaction_NoReportCrime = 512

Field Value

int

kFaction_SpecialCombat 

public const int kFaction_SpecialCombat = 2

Field Value

int

kFaction_TrackCrime 

public const int kFaction_TrackCrime = 16

Field Value

int

kFaction_Vendor 

public const int kFaction_Vendor = 4096

Field Value

int

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

CanPayCrimeGold(PapyrusScript<Faction>)

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

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.CanPayCrimeGold().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> CanPayCrimeGold(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<bool>

ClearFactionFlag(PapyrusScript<Faction>, int) 

public static Task ClearFactionFlag(this PapyrusScript<Faction> self, int flag)

Parameters

self PapyrusScript<Faction>
flag int

Returns

Task

ClearVendor(PapyrusScript<Faction>) 

public static Task ClearVendor(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task

GetBuySellList(PapyrusScript<Faction>) 

public static Task<FormList?> GetBuySellList(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<FormList?>

GetCrimeGold(PapyrusScript<Faction>)

Gets the amount of gold the player is to pay to this faction for crimes

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetCrimeGold().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetCrimeGold(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetCrimeGoldNonViolent(PapyrusScript<Faction>)

Gets the amount of gold the player is to pay to this faction for non-violent crimes

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetCrimeGoldNonViolent().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetCrimeGoldNonViolent(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetCrimeGoldViolent(PapyrusScript<Faction>)

Gets the amount of gold the player is to pay to this faction for violent crimes

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetCrimeGoldViolent().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetCrimeGoldViolent(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetInfamy(PapyrusScript<Faction>)

Get the player's "infamy" with this faction (accumulated crime gold)

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetInfamy().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetInfamy(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetInfamyNonViolent(PapyrusScript<Faction>)

Get the player's "non-violent infamy" with this faction (accumulated non-violent crime gold)

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetInfamyNonViolent().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetInfamyNonViolent(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetInfamyViolent(PapyrusScript<Faction>)

Get the player's "violent infamy" with this faction (accumulated violent crime gold)

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetInfamyViolent().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetInfamyViolent(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetMerchantContainer(PapyrusScript<Faction>) 

public static Task<ObjectReference?> GetMerchantContainer(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<ObjectReference?>

GetReaction(PapyrusScript<Faction>, Faction)

Gets this faction's reaction towards the other

public static Task<int> GetReaction(this PapyrusScript<Faction> self, Faction akOther)

Parameters

self PapyrusScript<Faction>
akOther Faction

Returns

Task<int>

GetStolenItemValueCrime(PapyrusScript<Faction>)

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

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetStolenItemValueCrime().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetStolenItemValueCrime(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetStolenItemValueNoCrime(PapyrusScript<Faction>)

Obtains the value of all items stolen by the player from this faction that was NOT witnessed

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.GetStolenItemValueNoCrime().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetStolenItemValueNoCrime(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetVendorEndHour(PapyrusScript<Faction>) 

public static Task<int> GetVendorEndHour(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetVendorRadius(PapyrusScript<Faction>) 

public static Task<int> GetVendorRadius(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

GetVendorStartHour(PapyrusScript<Faction>) 

public static Task<int> GetVendorStartHour(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<int>

IsFactionFlagSet(PapyrusScript<Faction>, int) 

public static Task<bool> IsFactionFlagSet(this PapyrusScript<Faction> self, int flag)

Parameters

self PapyrusScript<Faction>
flag int

Returns

Task<bool>

IsFactionInCrimeGroup(PapyrusScript<Faction>, Faction)

Is the passed in faction in this faction's crime group

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.IsFactionInCrimeGroup(Faction).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsFactionInCrimeGroup(this PapyrusScript<Faction> self, Faction akOther)

Parameters

self PapyrusScript<Faction>
akOther Faction

Returns

Task<bool>

IsNotSellBuy(PapyrusScript<Faction>) 

public static Task<bool> IsNotSellBuy(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<bool>

IsPlayerExpelled(PapyrusScript<Faction>)

Is the player expelled from this faction?

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.IsPlayerExpelled().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsPlayerExpelled(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<bool>

IsVendor(PapyrusScript<Faction>) 

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.IsVendor().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsVendor(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<bool>

MakeVendor(PapyrusScript<Faction>)

Not recommended unless the faction was previously a vendor due to the faction not having a package location the vendor may not be able to set up shop anywhere at all

public static Task MakeVendor(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task

ModCrimeGold(PapyrusScript<Faction>, int, bool)

Modifies the amount of crime gold for this faction - violent or non-violent

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.ModCrimeGold(int, bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ModCrimeGold(this PapyrusScript<Faction> self, int aiAmount, bool abViolent = false)

Parameters

self PapyrusScript<Faction>
aiAmount int
abViolent bool

Returns

Task

ModReaction(PapyrusScript<Faction>, Faction, int)

Modifies this faction's reaction towards the other faction

public static Task ModReaction(this PapyrusScript<Faction> self, Faction akOther, int aiAmount)

Parameters

self PapyrusScript<Faction>
akOther Faction
aiAmount int

Returns

Task

OnlyBuysStolenItems(PapyrusScript<Faction>) 

public static Task<bool> OnlyBuysStolenItems(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task<bool>

PlayerPayCrimeGold(PapyrusScript<Faction>, bool, bool)

Has the player pay the crime gold for this faction

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.PlayerPayCrimeGold(bool, bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task PlayerPayCrimeGold(this PapyrusScript<Faction> self, bool abRemoveStolenItems = true, bool abGoToJail = true)

Parameters

self PapyrusScript<Faction>
abRemoveStolenItems bool
abGoToJail bool

Returns

Task

SendAssaultAlarm(PapyrusScript<Faction>)

Finds a nearby NPC in this faction and has them behave as if assaulted

public static Task SendAssaultAlarm(this PapyrusScript<Faction> self)

Parameters

self PapyrusScript<Faction>

Returns

Task

SendPlayerToJail(PapyrusScript<Faction>, bool, bool)

Sends the player to this faction's jail - removing inventory if requested, and to a "real" jail or not

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.SendPlayerToJail(bool, bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SendPlayerToJail(this PapyrusScript<Faction> self, bool abRemoveInventory = true, bool abRealJail = true)

Parameters

self PapyrusScript<Faction>
abRemoveInventory bool
abRealJail bool

Returns

Task

SetAlly(PapyrusScript<Faction>, Faction, bool, bool)

Sets this faction and the other as allies or friends - if the friend booleans are true - the specified one-way relationship is a friend instead of an ally

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.SetAlly(Faction, bool, bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetAlly(this PapyrusScript<Faction> self, Faction akOther, bool abSelfIsFriendToOther = false, bool abOtherIsFriendToSelf = false)

Parameters

self PapyrusScript<Faction>
akOther Faction
abSelfIsFriendToOther bool
abOtherIsFriendToSelf bool

Returns

Task

SetBuySellList(PapyrusScript<Faction>, FormList) 

public static Task SetBuySellList(this PapyrusScript<Faction> self, FormList akList)

Parameters

self PapyrusScript<Faction>
akList FormList

Returns

Task

SetCrimeGold(PapyrusScript<Faction>, int)

Sets the non-violent crime gold on this faction

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.SetCrimeGold(int).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetCrimeGold(this PapyrusScript<Faction> self, int aiGold)

Parameters

self PapyrusScript<Faction>
aiGold int

Returns

Task

SetCrimeGoldViolent(PapyrusScript<Faction>, int)

Sets the violent crime gold on this faction

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.SetCrimeGoldViolent(int).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetCrimeGoldViolent(this PapyrusScript<Faction> self, int aiGold)

Parameters

self PapyrusScript<Faction>
aiGold int

Returns

Task

SetEnemy(PapyrusScript<Faction>, Faction, bool, bool)

Sets this faction and the other as enemies or neutral - if the friend booleans are true - the specified one-way relationship is a neutral instead of an enemy

[Obsolete("Uses the Papyrus virtual machine. Prefer Faction.SetEnemy(Faction, bool, bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetEnemy(this PapyrusScript<Faction> self, Faction akOther, bool abSelfIsNeutralToOther = false, bool abOtherIsNeutralToSelf = false)

Parameters

self PapyrusScript<Faction>
akOther Faction
abSelfIsNeutralToOther bool
abOtherIsNeutralToSelf bool

Returns

Task

SetFactionFlag(PapyrusScript<Faction>, int) 

public static Task SetFactionFlag(this PapyrusScript<Faction> self, int flag)

Parameters

self PapyrusScript<Faction>
flag int

Returns

Task

SetMerchantContainer(PapyrusScript<Faction>, IObjectReference) 

public static Task SetMerchantContainer(this PapyrusScript<Faction> self, IObjectReference akContainer)

Parameters

self PapyrusScript<Faction>
akContainer IObjectReference

Returns

Task

SetNotSellBuy(PapyrusScript<Faction>, bool) 

public static Task SetNotSellBuy(this PapyrusScript<Faction> self, bool notSellBuy)

Parameters

self PapyrusScript<Faction>
notSellBuy bool

Returns

Task

SetOnlyBuysStolenItems(PapyrusScript<Faction>, bool) 

public static Task SetOnlyBuysStolenItems(this PapyrusScript<Faction> self, bool onlyStolen)

Parameters

self PapyrusScript<Faction>
onlyStolen bool

Returns

Task

SetPlayerEnemy(PapyrusScript<Faction>, bool)

Sets or clears the player as an enemy of this faction

public static Task SetPlayerEnemy(this PapyrusScript<Faction> self, bool abIsEnemy = true)

Parameters

self PapyrusScript<Faction>
abIsEnemy bool

Returns

Task

SetPlayerExpelled(PapyrusScript<Faction>, bool)

Sets or clears the expelled flag for this faction on the player

public static Task SetPlayerExpelled(this PapyrusScript<Faction> self, bool abIsExpelled = true)

Parameters

self PapyrusScript<Faction>
abIsExpelled bool

Returns

Task

SetReaction(PapyrusScript<Faction>, Faction, int)

Sets this faction's reaction towards the other

public static Task SetReaction(this PapyrusScript<Faction> self, Faction akOther, int aiNewValue)

Parameters

self PapyrusScript<Faction>
akOther Faction
aiNewValue int

Returns

Task

SetVendorEndHour(PapyrusScript<Faction>, int) 

public static Task SetVendorEndHour(this PapyrusScript<Faction> self, int hour)

Parameters

self PapyrusScript<Faction>
hour int

Returns

Task

SetVendorRadius(PapyrusScript<Faction>, int) 

public static Task SetVendorRadius(this PapyrusScript<Faction> self, int radius)

Parameters

self PapyrusScript<Faction>
radius int

Returns

Task

SetVendorStartHour(PapyrusScript<Faction>, int) 

public static Task SetVendorStartHour(this PapyrusScript<Faction> self, int hour)

Parameters

self PapyrusScript<Faction>
hour int

Returns

Task