Difference between revisions of "Weapon Script"
Jump to navigation
Jump to search
imported>Behippo (→SKSE Member Functions: Added SKSE Member Function list) |
imported>CraftySentinel (Reverted to List) |
||
(9 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
'''Extends:''' [[Form Script]] | '''Extends:''' [[Form Script]] | ||
Script for the manipulation of weapon base objects. | Script for the manipulation of weapon base objects. | ||
== Definition == | == Definition == | ||
Line 11: | Line 8: | ||
ScriptName Weapon extends Form | ScriptName Weapon extends Form | ||
</source> | </source> | ||
== Properties == | == Properties == | ||
None | None | ||
== Global Functions == | == Global Functions == | ||
None | None | ||
== Member Functions == | == Member Functions == | ||
''' | |||
*Fires this weapon from the specified source object. | :'''[[Fire - Weapon|Fire]](ObjectReference ''akSource'')''' | ||
:*Fires this weapon from the specified source object. | |||
== SKSE Member Functions == | == SKSE Member Functions == | ||
''' | :'''Int [[GetBaseDamage - Weapon|GetBaseDamage]]()''' | ||
* | :*Returns the base damage of this weapon. | ||
''' | :'''[[SetBaseDamage - Weapon|SetBaseDamage]](Int ''damage'')''' | ||
* | :*Changes the base damage of this weapon. | ||
''' | :'''Int [[GetCritDamage - Weapon|GetCritDamage]]()''' | ||
* | :*Returns the critical damage of this weapon. | ||
''' | :'''[[SetCritDamage - Weapon|SetCritDamage]](Int ''damage'')''' | ||
* | :*Changes the critical damage of this weapon. | ||
''' | :'''Float [[GetReach - Weapon|GetReach]]()''' | ||
* | :*Returns the reach of this weapon. | ||
''' | :'''[[SetReach - Weapon|SetReach]](Float ''reach'')''' | ||
* | :*Changes the reach of this weapon. | ||
''' | :'''Float [[GetMinRange - Weapon|GetMinRange]]()''' | ||
* | :*Returns the minimum range of this weapon. | ||
''' | :'''[[SetMinRange - Weapon|SetMinRange]](Float ''minRange'')''' | ||
* | :*Changes the minimum range of this weapon. | ||
''' | :'''Float [[GetMaxRange - Weapon|GetMaxRange]]()''' | ||
* | :*Returns the maximum range of this weapon. | ||
''' | :'''[[SetMaxRange - Weapon|SetMaxRange]](Float ''maxRange'')''' | ||
* | :*Changes the maximum range of this weapon. | ||
''' | :'''Float [[GetSpeed - Weapon|GetSpeed]]()''' | ||
* | :*Returns the speed of this weapon. | ||
''' | :'''[[SetSpeed - Weapon|SetSpeed]](Float ''speed'')''' | ||
* | :*Changes the speed of this weapon. | ||
''' | :'''Float [[GetStagger - Weapon|GetStagger]]()''' | ||
* | :*Returns the stagger value of this weapon. | ||
''' | :'''[[SetStagger - Weapon|SetStagger]](Float ''stagger'')''' | ||
* | :*Changes the stagger value of this weapon. | ||
''' | :'''Int [[GetWeaponType - Weapon|GetWeaponType]]()''' | ||
* | :*Returns the weapon type of this weapon. | ||
''' | :'''[[SetWeaponType - Weapon|SetWeaponType]](Int ''type'')''' | ||
* | :*Changes the weapon type of this weapon. | ||
''' | :'''String [[GetModelPath - Weapon|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. | ||
''' | :'''String [[GetIconPath - Weapon|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. | ||
''' | :'''String [[GetMessageIconPath - Weapon|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. | ||
''' | :'''Enchantment [[GetEnchantment - Weapon|GetEnchantment]]()''' | ||
*Returns | :*Returns the Enchantment associated with the weapon. | ||
''' | :'''[[SetEnchantment - Weapon|SetEnchantment]](Enchantment ''e'')''' | ||
* | :*Set the Enchantment associated with the weapon. | ||
''' | :'''Int [[GetEnchantmentValue - Weapon|GetEnchantmentValue]]()''' | ||
*Returns | :*Returns the Enchantment Value of the associated weapon | ||
''' | :'''[[SetEnchantmentValue - Weapon|SetEnchantmentValue]](Int ''value'')''' | ||
* | :*Set the Enchantment value associated with the weapon. | ||
''' | :'''Static [[GetEquippedModel - Weapon|GetEquippedModel]]()''' | ||
*Returns | :*Returns the Equipped Model of the associated weapon. | ||
''' | :'''[[SetEquippedModel - Weapon|SetEquippedModel]](Static ''model'')''' | ||
* | :*Sets the Equipped Model of the associated weapon. | ||
''' | :'''EquipSlot [[GetEquipType - Weapon|GetEquipType]]()''' | ||
*Returns whether this weapon has the "WeapTypeWarhammer" keyword. | :*Returns the EquipSlot type of the weapon. | ||
:'''[[SetEquipType - Weapon|SetEquipType]](EquipSlot ''type'')''' | |||
:*Sets the EquipSlot of the weapon. | |||
:'''String [[GetSkill - Weapon|GetSkill]]()''' | |||
:*Returns the Skill associated with the weapon. | |||
:'''[[SetSkill - Weapon|SetSkill]](String ''skill'')''' | |||
:*Sets the Skill associated with the weapon. | |||
:'''String [[GetResist - Weapon|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. | |||
:'''Spell [[GetCritEffect - Weapon|GetCritEffect]]()''' | |||
:*Returns the Crit Effect associated with the weapon. | |||
:'''[[SetCritEffect - Weapon|SetCritEffect]](Spell ''ce'')''' | |||
:*Sets the Critical Effect of the weapon. | |||
:'''Bool [[GetCritEffectOnDeath - Weapon|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. | |||
:'''Float [[GetCritMultiplier - Weapon|GetCritMultiplier]]()''' | |||
:*Returns the weapon's Crit Multiplier. | |||
:'''[[SetCritMultiplier - Weapon|SetCritMultiplier]](Float ''crit'')''' | |||
:*Sets the Crit Multiplier of the weapon to the specified amount. | |||
:'''Bool [[IsBattleAxe - Weapon|IsBattleAxe]]()''' | |||
:*Returns whether this weapon has the "WeapTypeBattleaxe" keyword. | |||
:'''Bool [[IsBow - Weapon|IsBow]]()''' | |||
:*Returns whether this weapon has the "WeapTypeBow" keyword. | |||
:'''Bool [[IsDagger - Weapon|IsDagger]]()''' | |||
:*Returns whether this weapon has the "WeapTypeDagger" keyword. | |||
:'''Bool [[IsGreatsword - Weapon|IsGreatsword]]()''' | |||
:*Returns whether this weapon has the "WeapTypeGreatsword" keyword. | |||
:'''Bool [[IsMace - Weapon|IsMace]]()''' | |||
:*Returns whether this weapon has the "WeapTypeMace" keyword. | |||
:'''Bool [[IsStaff - Weapon|IsStaff]]()''' | |||
:*Returns whether this weapon has the "WeapTypeStaff" keyword. | |||
:'''Bool [[IsSword - Weapon|IsSword]]()''' | |||
:*Returns whether this weapon has the "WeapTypeSword" keyword. | |||
:'''Bool [[IsWarhammer - Weapon|IsWarhammer]]()''' | |||
:*Returns whether this weapon has the "WeapTypeWarhammer" keyword. | |||
:'''Bool [[IsWarAxe - Weapon|IsWarAxe]]()''' | |||
:*Returns whether this weapon has the "WeapTypeWarAxe" keyword. | |||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
[[Category:SKSE]] | |||
[[Category:SKSE Script Objects]] |
Latest revision as of 22:43, 2 February 2014
Extends: Form Script
Script for the manipulation of weapon base objects.
Definition[edit | edit source]
ScriptName Weapon extends Form
Properties[edit | edit source]
None
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- Fire(ObjectReference akSource)
- Fires this weapon from the specified source object.
SKSE Member Functions[edit | edit source]
- 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.
- SetSkill(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 ceod)
- Sets or unsets, if the Critical Effect should only occur on death.
- Float 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[edit | edit source]
None