Table of Contents

Class WeaponScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from Weapon.psc.

public static class WeaponScript
Inheritance
WeaponScript
Inherited Members

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

Fire(PapyrusScript<Weapon>, IObjectReference, Ammo?)

Fire this weapon base object from the specified source

public static Task Fire(this PapyrusScript<Weapon> self, IObjectReference akSource, Ammo? akAmmo = null)

Parameters

self PapyrusScript<Weapon>
akSource IObjectReference
akAmmo Ammo?

Returns

Task

GetBaseDamage(PapyrusScript<Weapon>)

public static Task<int> GetBaseDamage(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<int>

GetCritDamage(PapyrusScript<Weapon>)

public static Task<int> GetCritDamage(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<int>

GetCritEffect(PapyrusScript<Weapon>)

public static Task<Spell?> GetCritEffect(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<Spell?>

GetCritEffectOnDeath(PapyrusScript<Weapon>)

public static Task<bool> GetCritEffectOnDeath(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

GetCritMultiplier(PapyrusScript<Weapon>)

public static Task<float> GetCritMultiplier(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<float>

GetEnchantment(PapyrusScript<Weapon>)

public static Task<Enchantment?> GetEnchantment(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<Enchantment?>

GetEnchantmentValue(PapyrusScript<Weapon>)

public static Task<int> GetEnchantmentValue(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<int>

GetEquipType(PapyrusScript<Weapon>)

public static Task<EquipSlot?> GetEquipType(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<EquipSlot?>

GetEquippedModel(PapyrusScript<Weapon>)

public static Task<Static?> GetEquippedModel(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<Static?>

GetIconPath(PapyrusScript<Weapon>)

public static Task<string> GetIconPath(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<string>

GetMaxRange(PapyrusScript<Weapon>)

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

Parameters

self PapyrusScript<Weapon>

Returns

Task<float>

GetMessageIconPath(PapyrusScript<Weapon>)

public static Task<string> GetMessageIconPath(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<string>

GetMinRange(PapyrusScript<Weapon>)

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

Parameters

self PapyrusScript<Weapon>

Returns

Task<float>

GetModelPath(PapyrusScript<Weapon>)

public static Task<string> GetModelPath(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<string>

GetReach(PapyrusScript<Weapon>)

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

Parameters

self PapyrusScript<Weapon>

Returns

Task<float>

GetResist(PapyrusScript<Weapon>)

public static Task<string> GetResist(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<string>

GetSkill(PapyrusScript<Weapon>)

public static Task<string> GetSkill(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<string>

GetSpeed(PapyrusScript<Weapon>)

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

Parameters

self PapyrusScript<Weapon>

Returns

Task<float>

GetStagger(PapyrusScript<Weapon>)

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

Parameters

self PapyrusScript<Weapon>

Returns

Task<float>

GetTemplate(PapyrusScript<Weapon>)

returns the weapon template of this weapon

public static Task<Weapon?> GetTemplate(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<Weapon?>

GetWeaponType(PapyrusScript<Weapon>)

public static Task<int> GetWeaponType(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<int>

IsBattleaxe(PapyrusScript<Weapon>)

public static Task<bool> IsBattleaxe(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsBow(PapyrusScript<Weapon>)

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

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsDagger(PapyrusScript<Weapon>)

public static Task<bool> IsDagger(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsGreatsword(PapyrusScript<Weapon>)

public static Task<bool> IsGreatsword(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsMace(PapyrusScript<Weapon>)

public static Task<bool> IsMace(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsStaff(PapyrusScript<Weapon>)

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

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsSword(PapyrusScript<Weapon>)

public static Task<bool> IsSword(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsWarAxe(PapyrusScript<Weapon>)

public static Task<bool> IsWarAxe(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

IsWarhammer(PapyrusScript<Weapon>)

public static Task<bool> IsWarhammer(this PapyrusScript<Weapon> self)

Parameters

self PapyrusScript<Weapon>

Returns

Task<bool>

SetBaseDamage(PapyrusScript<Weapon>, int)

public static Task SetBaseDamage(this PapyrusScript<Weapon> self, int damage)

Parameters

self PapyrusScript<Weapon>
damage int

Returns

Task

SetCritDamage(PapyrusScript<Weapon>, int)

public static Task SetCritDamage(this PapyrusScript<Weapon> self, int damage)

Parameters

self PapyrusScript<Weapon>
damage int

Returns

Task

SetCritEffect(PapyrusScript<Weapon>, IPapyrusSpell)

public static Task SetCritEffect(this PapyrusScript<Weapon> self, IPapyrusSpell ce)

Parameters

self PapyrusScript<Weapon>
ce IPapyrusSpell

Returns

Task

SetCritEffectOnDeath(PapyrusScript<Weapon>, bool)

public static Task SetCritEffectOnDeath(this PapyrusScript<Weapon> self, bool ceod)

Parameters

self PapyrusScript<Weapon>
ceod bool

Returns

Task

SetCritMultiplier(PapyrusScript<Weapon>, float)

public static Task SetCritMultiplier(this PapyrusScript<Weapon> self, float crit)

Parameters

self PapyrusScript<Weapon>
crit float

Returns

Task

SetEnchantment(PapyrusScript<Weapon>, Enchantment)

public static Task SetEnchantment(this PapyrusScript<Weapon> self, Enchantment e)

Parameters

self PapyrusScript<Weapon>
e Enchantment

Returns

Task

SetEnchantmentValue(PapyrusScript<Weapon>, int)

public static Task SetEnchantmentValue(this PapyrusScript<Weapon> self, int value)

Parameters

self PapyrusScript<Weapon>
value int

Returns

Task

SetEquipType(PapyrusScript<Weapon>, EquipSlot)

public static Task SetEquipType(this PapyrusScript<Weapon> self, EquipSlot type)

Parameters

self PapyrusScript<Weapon>
type EquipSlot

Returns

Task

SetEquippedModel(PapyrusScript<Weapon>, Static)

public static Task SetEquippedModel(this PapyrusScript<Weapon> self, Static model)

Parameters

self PapyrusScript<Weapon>
model Static

Returns

Task

SetIconPath(PapyrusScript<Weapon>, string)

public static Task SetIconPath(this PapyrusScript<Weapon> self, string path)

Parameters

self PapyrusScript<Weapon>
path string

Returns

Task

SetMaxRange(PapyrusScript<Weapon>, float)

public static Task SetMaxRange(this PapyrusScript<Weapon> self, float maxRange)

Parameters

self PapyrusScript<Weapon>
maxRange float

Returns

Task

SetMessageIconPath(PapyrusScript<Weapon>, string)

public static Task SetMessageIconPath(this PapyrusScript<Weapon> self, string path)

Parameters

self PapyrusScript<Weapon>
path string

Returns

Task

SetMinRange(PapyrusScript<Weapon>, float)

public static Task SetMinRange(this PapyrusScript<Weapon> self, float minRange)

Parameters

self PapyrusScript<Weapon>
minRange float

Returns

Task

SetModelPath(PapyrusScript<Weapon>, string)

public static Task SetModelPath(this PapyrusScript<Weapon> self, string path)

Parameters

self PapyrusScript<Weapon>
path string

Returns

Task

SetReach(PapyrusScript<Weapon>, float)

public static Task SetReach(this PapyrusScript<Weapon> self, float reach)

Parameters

self PapyrusScript<Weapon>
reach float

Returns

Task

SetResist(PapyrusScript<Weapon>, string)

public static Task SetResist(this PapyrusScript<Weapon> self, string resist)

Parameters

self PapyrusScript<Weapon>
resist string

Returns

Task

SetSkill(PapyrusScript<Weapon>, string)

public static Task SetSkill(this PapyrusScript<Weapon> self, string skill)

Parameters

self PapyrusScript<Weapon>
skill string

Returns

Task

SetSpeed(PapyrusScript<Weapon>, float)

public static Task SetSpeed(this PapyrusScript<Weapon> self, float speed)

Parameters

self PapyrusScript<Weapon>
speed float

Returns

Task

SetStagger(PapyrusScript<Weapon>, float)

public static Task SetStagger(this PapyrusScript<Weapon> self, float stagger)

Parameters

self PapyrusScript<Weapon>
stagger float

Returns

Task

SetWeaponType(PapyrusScript<Weapon>, int)

public static Task SetWeaponType(this PapyrusScript<Weapon> self, int type)

Parameters

self PapyrusScript<Weapon>
type int

Returns

Task