Weapon Script

Revision as of 06:23, 28 October 2013 by imported>CraftySentinel (→‎SKSE Member Functions: Added SKSE Member Functions that were missing)


Extends: Form Script

Script for the manipulation of weapon base objects.

Definition

ScriptName Weapon extends Form

Properties

None

Global Functions

None

Member Functions

Function Description
Fire(ObjectReference akSource) Fires this weapon from the specified source object.

SKSE Member Functions

Function Description
Int GetBaseDamage() Returns the base damage of this weapon.
SetBaseDamage(Int damage) Changes the base damage of this weapon.
Int GetCritDamage() Returns the critical damage of this weapon.
SetCritDamage(Int damage) Changes the critical damage of this weapon.
Float GetReach() Returns the reach of this weapon.
SetReach(Float reach) Changes the reach of this weapon.
Float GetMinRange() Returns the minimum range of this weapon.
SetMinRange(Float minRange) Changes the minimum range of this weapon.
Float GetMaxRange() Returns the maximum range of this weapon.
SetMaxRange(Float maxRange) Changes the maximum range of this weapon.
Float GetSpeed() Returns the speed of this weapon.
SetSpeed(Float speed) Changes the speed of this weapon.
Float GetStagger() Returns the stagger value of this weapon.
SetStagger(Float stagger) Changes the stagger value of this weapon.
Int GetWeaponType() Returns the weapon type of this weapon.
SetWeaponType(Int type) Changes the weapon type of this weapon.
String GetModelPath() Returns the path to the file representing the in-game model of this weapon.
SetModelPath(String path) Changes the path to the file representing the in-game model of this weapon.
String GetIconPath() Returns the path to the file representing the icon of this weapon in the inventory.
SetIconPath(String path) Changes the path to the file representing the icon of this weapon in the inventory.
String GetMessageIconPath() Returns the path to the file representing the message icon for this weapon.
SetMessageIconPath(String path) Changes the path to the file representing the message icon for this weapon.
Enchantment GetEnchantment() Returns the Enchantment associated with the weapon.
SetEnchantment(Enchantment e) Set the Enchantment associated with the weapon.
Int GetEnchantmentValue() Returns the Enchantment Value of the associated weapon
SetEnchantmentValue(Int value) Set the Enchantment value associated with the weapon.
Static GetEquippedModel() Returns the Equipped Model of the associated weapon.
SetEquippedModel(Static model) Sets the Equipped Model of the associated weapon.
EquipSlot GetEquipType() Returns the EquipSlot type of the weapon.
SetEquipType(EquipSlot type) Sets the EquipSlot of the weapon.
String GetSkill() Returns the Skill associated with the weapon.
SetEquipType(String skill) Sets the Skill associated with the weapon.
String GetResist() Returns the Actor Value Name of the Resistance that affects the damage of the weapon.
SetResist(String resist) Sets the Resistance associated to the weapon.
Spell GetCritEffect() Returns the Crit Effect associated with the weapon.
SetCritEffect(Spell ce) Sets the Critical Effect of the weapon.
Bool GetCritEffectOnDeath() Returns whether the Critical Effect associated with the weapon should only occur on death.
SetCritEffectOnDeath(Bool coed) Sets or unsets, if the Critical Effect should only occur on death.
Bool GetCritMultiplier() Returns the weapon's Crit Multiplier.
SetCritMultiplier(Float crit) Sets the Crit Multiplier of the weapon to the specified amount.
Bool IsBattleAxe() Returns whether this weapon has the "WeapTypeBattleaxe" keyword.
Bool IsBow() Returns whether this weapon has the "WeapTypeBow" keyword.
Bool IsDagger() Returns whether this weapon has the "WeapTypeDagger" keyword.
Bool IsGreatsword() Returns whether this weapon has the "WeapTypeGreatsword" keyword.
Bool IsMace() Returns whether this weapon has the "WeapTypeMace" keyword.
Bool IsStaff() Returns whether this weapon has the "WeapTypeStaff" keyword.
Bool IsSword() Returns whether this weapon has the "WeapTypeSword" keyword.
Bool IsWarhammer() Returns whether this weapon has the "WeapTypeWarhammer" keyword.
Bool IsWarAxe() Returns whether this weapon has the "WeapTypeWarAxe" keyword.

Events

None