Difference between revisions of "Weapon Script"

!style="text-align:left;"|Function

|[[Fire - Weapon|'''Fire'''(ObjectReference ''akSource'')]]

|Fires this weapon from the specified source object.

!style="text-align:left;"|Function

|[[GetBaseDamage - Weapon|Int '''GetBaseDamage'''()]]

|Returns the base damage of this weapon.

|[[SetBaseDamage - Weapon|'''SetBaseDamage'''(Int ''damage'')]]

|Changes the base damage of this weapon.

|[[GetCritDamage - Weapon|Int '''GetCritDamage'''()]]

|Returns the critical damage of this weapon.

|[[SetCritDamage - Weapon|'''SetCritDamage'''(Int ''damage'')]]

|Changes the critical damage of this weapon.

|[[GetReach - Weapon|Float '''GetReach'''()]]

|Returns the reach of this weapon.

|[[SetReach - Weapon|'''SetReach'''(Float ''reach'')]]

|Changes the reach of this weapon.

|[[GetMinRange - Weapon|Float '''GetMinRange'''()]]

|Returns the minimum range of this weapon.

|[[SetMinRange - Weapon|'''SetMinRange'''(Float ''minRange'')]]

|Changes the minimum range of this weapon.

|[[GetMaxRange - Weapon|Float '''GetMaxRange'''()]]

|Returns the maximum range of this weapon.

|[[SetMaxRange - Weapon|'''SetMaxRange'''(Float ''maxRange'')]]

|Changes the maximum range of this weapon.

|[[GetSpeed - Weapon|Float '''GetSpeed'''()]]

|Returns the speed of this weapon.

|[[SetSpeed - Weapon|'''SetSpeed'''(Float ''speed'')]]

|Changes the speed of this weapon.

|[[GetStagger - Weapon|Float '''GetStagger'''()]]

|Returns the stagger value of this weapon.

|[[SetStagger - Weapon|'''SetStagger'''(Float ''stagger'')]]

|Changes the stagger value of this weapon.

|[[GetWeaponType - Weapon|Int '''GetWeaponType'''()]]

|Returns the weapon type of this weapon.

|[[SetWeaponType - Weapon|'''SetWeaponType'''(Int ''type'')]]

|Changes the weapon type of this weapon.

|[[GetModelPath - Weapon|String '''GetModelPath'''()]]

|Returns the path to the file representing the in-game model of this weapon.

|[[SetModelPath - Weapon|'''SetModelPath'''(String ''path'')]]

|Changes the path to the file representing the in-game model of this weapon.

|[[GetIconPath - Weapon|String '''GetIconPath'''()]]

|Returns the path to the file representing the icon of this weapon in the inventory.

|[[SetIconPath - Weapon|'''SetIconPath'''(String ''path'')]]

|Changes the path to the file representing the icon of this weapon in the inventory.

|[[GetMessageIconPath - Weapon|String '''GetMessageIconPath'''()]]

|Returns the path to the file representing the message icon for this weapon.

|[[SetMessageIconPath - Weapon|'''SetMessageIconPath'''(String ''path'')]]

|Changes the path to the file representing the message icon for this weapon.

|[[GetEnchantment - Weapon|Enchantment '''GetEnchantment'''()]]

|Returns the Enchantment associated with the weapon.

|[[SetEnchantment - Weapon|'''SetEnchantment'''(Enchantment ''e'')]]

|Set the Enchantment associated with the weapon.

|[[GetEnchantmentValue - Weapon|Int '''GetEnchantmentValue'''()]]

|Returns the Enchantment Value of the associated weapon

|[[SetEnchantmentValue - Weapon|'''SetEnchantmentValue'''(Int ''value'')]]

|Set the Enchantment value associated with the weapon.

|[[GetEquippedModel - Weapon|Static '''GetEquippedModel'''()]]

|Returns the Equipped Model of the associated weapon.

|[[SetEquippedModel - Weapon|'''SetEquippedModel'''(Static ''model'')]]

|Sets the Equipped Model of the associated weapon.

|[[GetEquipType - Weapon|EquipSlot '''GetEquipType'''()]]

|Returns the EquipSlot type of the weapon.

|[[SetEquipType - Weapon|'''SetEquipType'''(EquipSlot ''type'')]]

|Sets the EquipSlot of the weapon.

|[[GetSkill - Weapon|String '''GetSkill'''()]]

|Returns the Skill associated with the weapon.

|[[SetSkill - Weapon|'''SetSkill'''(String ''skill'')]]

|Sets the Skill associated with the weapon.

|[[GetResist - Weapon|String '''GetResist'''()]]

|Returns the Actor Value Name of the Resistance that affects the damage of the weapon.

|[[SetResist - Weapon|'''SetResist'''(String ''resist'')]]

|Sets the Resistance associated to the weapon.

|[[GetCritEffect - Weapon|Spell '''GetCritEffect'''()]]

|Returns the Crit Effect associated with the weapon.

|[[SetCritEffect - Weapon|'''SetCritEffect'''(Spell ''ce'')]]

|Sets the Critical Effect of the weapon.

|[[GetCritEffectOnDeath - Weapon|Bool '''GetCritEffectOnDeath'''()]]

|Returns whether the Critical Effect associated with the weapon should only occur on death.

|[[SetCritEffectOnDeath - Weapon|'''SetCritEffectOnDeath'''(Bool ''ceod'')]]

|Sets or unsets, if the Critical Effect should only occur on death.

|[[GetCritMultiplier - Weapon|Float '''GetCritMultiplier'''()]]

|Returns the weapon's Crit Multiplier.

|[[SetCritMultiplier - Weapon|'''SetCritMultiplier'''(Float ''crit'')]]

|Sets the Crit Multiplier of the weapon to the specified amount.

|[[IsBattleAxe - Weapon|Bool '''IsBattleAxe'''()]]

|Returns whether this weapon has the "WeapTypeBattleaxe" keyword.

|[[IsBow - Weapon|Bool '''IsBow'''()]]

|Returns whether this weapon has the "WeapTypeBow" keyword.

|[[IsDagger - Weapon|Bool '''IsDagger'''()]]

|Returns whether this weapon has the "WeapTypeDagger" keyword.

|[[IsGreatsword - Weapon|Bool '''IsGreatsword'''()]]

|Returns whether this weapon has the "WeapTypeGreatsword" keyword.

|[[IsMace - Weapon|Bool '''IsMace'''()]]

|Returns whether this weapon has the "WeapTypeMace" keyword.

|[[IsStaff - Weapon|Bool '''IsStaff'''()]]

|Returns whether this weapon has the "WeapTypeStaff" keyword.

|[[IsSword - Weapon|Bool '''IsSword'''()]]

|Returns whether this weapon has the "WeapTypeSword" keyword.

|[[IsWarhammer - Weapon|Bool '''IsWarhammer'''()]]

|Returns whether this weapon has the "WeapTypeWarhammer" keyword.

|[[IsWarAxe - Weapon|Bool '''IsWarAxe'''()]]

|Returns whether this weapon has the "WeapTypeWarAxe" keyword.