Difference between revisions of "Weapon Script"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jog
imported>Behippo
(→‎SKSE Member Functions: Added SKSE Member Function list)
Line 21: Line 21:
'''Function [[Fire - Weapon|Fire]](ObjectReference akSource)'''
'''Function [[Fire - Weapon|Fire]](ObjectReference akSource)'''
*Fires this weapon from the specified source object.
*Fires this weapon from the specified source object.
== SKSE Member Functions ==
'''int Function [[GetBaseDamage - Weapon|GetBaseDamage]]()'''
*Returns the base damage of this weapon.
'''Function [[SetBaseDamage - Weapon|SetBaseDamage]](int damage)'''
*Changes the base damage of this weapon.
'''int Function [[GetCritDamage - Weapon|GetCritDamage]]()'''
*Returns the critical damage of this weapon.
'''Function [[SetCritDamage - Weapon|SetCritDamage]](int damage)'''
*Changes the base damage of this weapon.
'''float Function [[GetReach - Weapon|GetReach]]()'''
*Returns the reach of this weapon.
'''Function [[SetReach - Weapon|SetReach]](float reach)'''
*Changes the reach of this weapon.
'''float Function [[GetMinRange - Weapon|GetMinRange]]()'''
*Returns the minimum range of this weapon.
'''Function [[SetMinRange - Weapon|SetMinRange]](float minRange)'''
*Changes the minimum range of this weapon.
'''float Function [[GetMaxRange - Weapon|GetMaxRange]]()'''
*Returns the maximum range of this weapon.
'''Function [[SetMaxRange - Weapon|SetMaxRange]](float maxRange)'''
*Changes the maximum range of this weapon.
'''float Function [[GetSpeed - Weapon|GetSpeed]]()'''
*Returns the speed of this weapon.
'''Function [[SetSpeed - Weapon|SetSpeed]](float speed)'''
*Changes the speed of this weapon.
'''float Function [[GetStagger - Weapon|GetStagger]]()'''
*Returns the stagger value of this weapon.
'''Function [[SetStagger - Weapon|SetStagger]](float stagger)'''
*Changes the stagger value of this weapon.
'''int Function [[GetWeaponType - Weapon|GetWeaponType]]()'''
*Returns the weapon type of this weapon.
'''Function [[SetWeaponType - Weapon|SetWeaponType]](int type)'''
*Changes the weapon type of this weapon.
'''string Function [[GetModelPath - Weapon|GetModelPath]]()'''
*Returns the path to the file representing the in-game model of this weapon.
'''Function [[SetModelPath - Weapon|SetModelPath]](string path)'''
*Changes the path to the file representing the in-game model of this weapon.
'''string Function [[GetIconPath - Weapon|GetIconPath]]()'''
*Returns the path to the file representing the icon of this weapon in the inventory.
'''Function [[SetIconPath - Weapon|SetIconPath]](string path)'''
*Changes the path to the file representing the icon of this weapon in the inventory.
'''string Function [[GetMessageIconPath - Weapon|GetMessageIconPath]]()'''
*Returns the path to the file representing the message icon for this weapon.
'''Function [[SetMessageIconPath - Weapon|SetMessageIconPath]](string path)'''
*Changes the path to the file representing the message icon for this weapon.
'''bool Function [[IsBattleAxe - Weapon|IsBattleaxe]]()'''
*Returns whether this weapon has the "WeapTypeBattleaxe" keyword.
'''bool Function [[IsBow - Weapon|IsBow]]()'''
*Returns whether this weapon has the "WeapTypeBow" keyword.
'''bool Function [[IsDagger - Weapon|IsDagger]]()'''
*Returns whether this weapon has the "WeapTypeDagger" keyword.
'''bool Function [[IsGreatsword - Weapon|IsGreatsword]]()'''
*Returns whether this weapon has the "WeapTypeGreatsword" keyword.
'''bool Function [[IsMace - Weapon|IsMace]]()'''
*Returns whether this weapon has the "WeapTypeMace" keyword.
'''bool Function [[IsStaff - Weapon|IsStaff]]()'''
*Returns whether this weapon has the "WeapTypeStaff" keyword.
'''bool Function [[IsSword - Weapon|IsSword]]()'''
*Returns whether this weapon has the "WeapTypeSword" keyword.
'''bool Function [[IsWarhammer - Weapon|IsWarhammer]]()'''
*Returns whether this weapon has the "WeapTypeWarhammer" keyword.
'''bool Function [[IsWarAxe - Weapon|IsWarAxe]]()'''
*Returns whether this weapon has the "WeapTypeWarAxe" keyword.


== Events ==
== Events ==
None
None

Revision as of 15:27, 10 May 2012


Extends: Form Script

Script for the manipulation of weapon base objects.

Definition

ScriptName Weapon extends Form

Properties

None

Global Functions

None

Member Functions

Function Fire(ObjectReference akSource)

  • Fires this weapon from the specified source object.

SKSE Member Functions

int Function GetBaseDamage()

  • Returns the base damage of this weapon.

Function SetBaseDamage(int damage)

  • Changes the base damage of this weapon.

int Function GetCritDamage()

  • Returns the critical damage of this weapon.

Function SetCritDamage(int damage)

  • Changes the base damage of this weapon.

float Function GetReach()

  • Returns the reach of this weapon.

Function SetReach(float reach)

  • Changes the reach of this weapon.

float Function GetMinRange()

  • Returns the minimum range of this weapon.

Function SetMinRange(float minRange)

  • Changes the minimum range of this weapon.

float Function GetMaxRange()

  • Returns the maximum range of this weapon.

Function SetMaxRange(float maxRange)

  • Changes the maximum range of this weapon.

float Function GetSpeed()

  • Returns the speed of this weapon.

Function SetSpeed(float speed)

  • Changes the speed of this weapon.

float Function GetStagger()

  • Returns the stagger value of this weapon.

Function SetStagger(float stagger)

  • Changes the stagger value of this weapon.

int Function GetWeaponType()

  • Returns the weapon type of this weapon.

Function SetWeaponType(int type)

  • Changes the weapon type of this weapon.

string Function GetModelPath()

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

Function SetModelPath(string path)

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

string Function GetIconPath()

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

Function SetIconPath(string path)

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

string Function GetMessageIconPath()

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

Function SetMessageIconPath(string path)

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

bool Function IsBattleaxe()

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

bool Function IsBow()

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

bool Function IsDagger()

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

bool Function IsGreatsword()

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

bool Function IsMace()

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

bool Function IsStaff()

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

bool Function IsSword()

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

bool Function IsWarhammer()

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

bool Function IsWarAxe()

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

Events

None