Difference between revisions of "InstanceData Script"
Jump to navigation
Jump to search
imported>ShadeMe m (Fix Damage Type linkage) |
imported>Qazaaq (added required f4se version) |
||
(7 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
'''Extends:''' [[ScriptObject Script|ScriptObject]] | '''Extends:''' [[ScriptObject Script|ScriptObject]] | ||
{{Template:Papyrus:RequiredF4SE|version=0.3.1}} | |||
Script for the manipulation of object InstanceData. | Script for the manipulation of object InstanceData. | ||
Line 15: | Line 11: | ||
== Properties == | == Properties == | ||
None | None | ||
== F4SE Properties == | |||
*'''Flags''': Set of read-only properties to essentially make a fake enum for ''Flags''. | |||
**int Flag_IgnoresNormalResist: 0x0000002 | |||
**int Flag_MinorCrime: 0x0000004 | |||
**int Flag_ChargingReload: 0x0000008 | |||
**int Flag_HideBackpack: 0x0000010 | |||
**int Flag_NonHostile: 0x0000040 | |||
**int Flag_NPCsUseAmmo: 0x0000200 | |||
**int Flag_RepeatableSingleFire: 0x0000800 | |||
**int Flag_HasScope: 0x0001000 | |||
**int Flag_HoldInputToPower: 0x0002000 | |||
**int Flag_Automatic: 0x0004000 | |||
**int Flag_CantDrop: 0x0008000 | |||
**int Flag_ChargingAttack: 0x0010000 | |||
**int Flag_NotUsedInNormalCombat: 0x0020000 | |||
**int Flag_BoundWeapon: 0x0040000 | |||
**int Flag_SecondaryWeapon: 0x0200000 | |||
**int Flag_BoltAction: 0x0400000 | |||
**int Flag_NoJamAfterReload: 0x0800000 | |||
**int Flag_DisableShells: 0x1000000 | |||
== F4SE Structs == | == F4SE Structs == | ||
*Struct [[Owner Struct - InstanceData|Owner]] | *Struct [[Owner Struct - InstanceData|Owner]] | ||
**A structure that holds information about an object | **A structure that holds information about an object. | ||
*Struct [[DamageTypeInfo Struct - InstanceData|DamageTypeInfo]] | *Struct [[DamageTypeInfo Struct - InstanceData|DamageTypeInfo]] | ||
**A structure that holds information about an object's [[Damage Type|Damage Types]]. | **A structure that holds information about an object's [[Damage Type|Damage Types]]. | ||
Line 26: | Line 43: | ||
== F4SE Global Functions == | == F4SE Global Functions == | ||
*Function [[GetAttackDamage - InstanceData|GetAttackDamage]]() | *int Function [[GetAccuracyBonus - InstanceData|GetAccuracyBonus]](Owner akOwner) | ||
** | **Gets the object's current accuracy bonus. | ||
*Function [[SetAttackDamage - InstanceData|SetAttackDamage]]() | |||
** | *float Function [[GetActionPointCost - InstanceData|GetActionPointCost]](Owner akOwner) | ||
**Gets the object's current action point cost in VATS. | |||
*Ammo Function [[GetAmmo - InstanceData|GetAmmo]](Owner akOwner) | |||
**Gets the object's current ammo. | |||
*int Function [[GetAmmoCapacity - InstanceData|GetAmmoCapacity]](Owner akOwner) | |||
**Gets the object's ammo capacity. | |||
*int Function [[GetArmorHealth - InstanceData|GetArmorHealth]](Owner akOwner) | |||
**Gets the object's current armor health. | |||
*int Function [[GetArmorRating - InstanceData|GetArmorRating]](Owner akOwner) | |||
**Gets the object's armor rating. | |||
*int Function [[GetAttackDamage - InstanceData|GetAttackDamage]](Owner akOwner) | |||
**Gets the object's attack damage. | |||
*float Function [[GetAttackDelay - InstanceData|GetAttackDelay]](Owner akOwner) | |||
**Gets the object's current attack delay. | |||
*float Function [[GetCritChargeBonus - InstanceData|GetCritChargeBonus]](Owner akOwner) | |||
**Gets the object's current critical charge bonus. | |||
*float Function [[GetCritMultiplier - InstanceData|GetCritMultiplier]](Owner akOwner) | |||
**Gets the object's current critical multiplier. | |||
*DamageTypeInfo[] Function [[GetDamageTypes - InstanceData|GetDamageTypes]](Owner akOwner) | |||
**Gets the object's damage types, as an array. | |||
*bool Function [[GetFlag - InstanceData|GetFlag]](Owner akOwner, int flag) | |||
**Gets the state of the passed flag on the object. | |||
*int Function [[GetGoldValue - InstanceData|GetGoldValue]](Owner akOwner) | |||
**Gets the object's current gold (cap) value. | |||
*Keyword[] Function [[GetKeywords - InstanceData|GetKeywords]](Owner akOwner) | |||
**Gets the object's current keywords, as an array. | |||
*float Function [[GetMaxRange - InstanceData|GetMaxRange]](Owner akOwner) | |||
**Gets the object's current max range. | |||
*float Function [[GetMinRange - InstanceData|GetMinRange]](Owner akOwner) | |||
**Gets the object's current min range. | |||
*int Function [[GetNumProjectiles - InstanceData|GetNumProjectiles]](Owner akOwner) | |||
**Gets the object's current number of projectiles per shot. | |||
*float Function [[GetOutOfRangeMultiplier - InstanceData|GetOutOfRangeMultiplier]](Owner akOwner) | |||
**Gets the object's current out of range multiplier. | |||
*Projectile Function [[GetProjectileOverride - InstanceData|GetProjectileOverride]](Owner akOwner) | |||
**Gets the object's current projectile override. | |||
*float Function [[GetReach - InstanceData|GetReach]](Owner akOwner) | |||
**Gets the object's current reach. | |||
*float Function [[GetReloadSpeed - InstanceData|GetReloadSpeed]](Owner akOwner) | |||
**Gets the object's current reload speed. | |||
*ActorValue Function [[GetResist - InstanceData|GetResist]](Owner akOwner) | |||
**Gets the object's current resist ActorValue. | |||
*float Function [[GetSightedTransition - InstanceData|GetSightedTransition]](Owner akOwner) | |||
**Gets the object's current sighted transition time. | |||
*ActorValue Function [[GetSkill - InstanceData|GetSkill]](Owner akOwner) | |||
**Gets the object's current skill ActorValue. | |||
*float Function [[GetSpeed - InstanceData|GetSpeed]](Owner akOwner) | |||
**Gets the object's current speed. | |||
*int Function [[GetStagger - InstanceData|GetStagger]](Owner akOwner) | |||
**Gets the object's current stagger. | |||
*float Function [[GetWeight - InstanceData|GetWeight]](Owner akOwner) | |||
**Gets the object's current weight. | |||
*Function [[SetAccuracyBonus - InstanceData|SetAccuracyBonus]](Owner akOwner, int aiBonus) | |||
**Sets the object's current accuracy bonus. | |||
*Function [[SetActionPointCost - InstanceData|SetActionPointCost]](Owner akOwner, float afCost) | |||
**Sets the object's current action point cost in VATS. | |||
*Function [[SetAmmo - InstanceData|SetAmmo]](Owner akOwner, Ammo akAmmo) | |||
**Sets the object's current ammo. | |||
*Function [[SetAmmoCapacity - InstanceData|SetAmmoCapacity]](Owner akOwner, int aiCapacity) | |||
**Sets the object's ammo capacity. | |||
*Function [[SetArmorHealth - InstanceData|SetArmorHealth]](Owner akOwner, int aiHealth) | |||
**Sets the object's current armor health. | |||
*Function [[SetArmorRating - InstanceData|SetArmorRating]](Owner akOwner, int aiRating) | |||
**Sets the object's armor rating. | |||
*Function [[SetAttackDamage - InstanceData|SetAttackDamage]](Owner akOwner, int aiDamage) | |||
**Sets the object's attack damage. | |||
*Function [[SetAttackDelay - InstanceData|SetAttackDelay]](Owner akOwner, float afDelay) | |||
**Sets the object's current attack delay. | |||
*Function [[SetCritChargeBonus - InstanceData|SetCritChargeBonus]](Owner akOwner, float afBonus) | |||
**Sets the object's current critical charge bonus. | |||
*Function [[SetCritMultiplier - InstanceData|SetCritMultiplier]](Owner akOwner, float afMult) | |||
**Sets the object's current critical multiplier. | |||
*Function [[SetDamageTypes - InstanceData|SetDamageTypes]](Owner akOwner, DamageTypeInfo[] akDamageInfo) | |||
**Sets the object's damage types, using an array. | |||
*Function [[SetFlag - InstanceData|SetFlag]](Owner akOwner, int flag, bool abSet) | |||
**Sets the state of the passed flag on the object. | |||
*Function [[SetGoldValue - InstanceData|SetGoldValue]](Owner akOwner, int aiValue) | |||
**Sets the object's current gold (cap) value. | |||
*Function [[SetKeywords - InstanceData|SetKeywords]](Owner akOwner, Keyword[] akKeywords) | |||
**Sets the object's current keywords, using an array. | |||
*Function [[SetMaxRange - InstanceData|SetMaxRange]](Owner akOwner, float afRange) | |||
**Sets the object's current max range. | |||
*Function [[SetMinRange - InstanceData|SetMinRange]](Owner akOwner, float afRange) | |||
**Sets the object's current min range. | |||
*Function [[SetNumProjectiles - InstanceData|SetNumProjectiles]](Owner akOwner, int aiNumProj) | |||
**Sets the object's current number of projectiles per shot. | |||
*Function [[SetOutOfRangeMultiplier - InstanceData|SetOutOfRangeMultiplier]](Owner akOwner, float afMult) | |||
**Sets the object's current out of range multiplier. | |||
*Function [[SetProjectileOverride - InstanceData|SetProjectileOverride]](Owner akOwner, Projectile akProj) | |||
**Sets the object's current projectile override. | |||
*Function [[SetReach - InstanceData|SetReach]](Owner akOwner, float afReach) | |||
**Sets the object's current reach. | |||
*Function [[SetReloadSpeed - InstanceData|SetReloadSpeed]](Owner akOwner, float afSpeed) | |||
**Sets the object's current reload speed. | |||
*Function [[SetResist - InstanceData|SetResist]](Owner akOwner, ActorValue akResist) | |||
**Sets the object's current resist ActorValue. | |||
*Function [[SetSightedTransition - InstanceData|SetSightedTransition]](Owner akOwner, float afSeconds) | |||
**Sets the object's current sighted transition time. | |||
*Function [[SetSkill - InstanceData|SetSkill]](Owner akOwner, ActorValue akSkill) | |||
**Sets the object's current skill ActorValue. | |||
*Function [[SetSpeed - InstanceData|SetSpeed]](Owner akOwner, float afSpeed) | |||
**Sets the object's current speed. | |||
*Function [[SetStagger - InstanceData|SetStagger]](Owner akOwner, int aiStagger) | |||
**Sets the object's current stagger. | |||
*Function [[SetWeight - InstanceData|SetWeight]](Owner akOwner, float afWeight) | |||
**Sets the object's current weight. | |||
== Member Functions == | == Member Functions == | ||
Line 39: | Line 213: | ||
== Events == | == Events == | ||
None | None | ||
[[Category:Scripting]] | |||
[[Category:Papyrus]] | |||
[[Category:Script Objects]] | |||
[[Category:F4SE]] |
Latest revision as of 16:07, 21 January 2018
Extends: ScriptObject
Requires F4SE version 0.3.1 or higher.
Script for the manipulation of object InstanceData.
Definition[edit | edit source]
ScriptName InstanceData Native Hidden
Properties[edit | edit source]
None
F4SE Properties[edit | edit source]
- Flags: Set of read-only properties to essentially make a fake enum for Flags.
- int Flag_IgnoresNormalResist: 0x0000002
- int Flag_MinorCrime: 0x0000004
- int Flag_ChargingReload: 0x0000008
- int Flag_HideBackpack: 0x0000010
- int Flag_NonHostile: 0x0000040
- int Flag_NPCsUseAmmo: 0x0000200
- int Flag_RepeatableSingleFire: 0x0000800
- int Flag_HasScope: 0x0001000
- int Flag_HoldInputToPower: 0x0002000
- int Flag_Automatic: 0x0004000
- int Flag_CantDrop: 0x0008000
- int Flag_ChargingAttack: 0x0010000
- int Flag_NotUsedInNormalCombat: 0x0020000
- int Flag_BoundWeapon: 0x0040000
- int Flag_SecondaryWeapon: 0x0200000
- int Flag_BoltAction: 0x0400000
- int Flag_NoJamAfterReload: 0x0800000
- int Flag_DisableShells: 0x1000000
F4SE Structs[edit | edit source]
- Struct Owner
- A structure that holds information about an object.
- Struct DamageTypeInfo
- A structure that holds information about an object's Damage Types.
Global Functions[edit | edit source]
None
F4SE Global Functions[edit | edit source]
- int Function GetAccuracyBonus(Owner akOwner)
- Gets the object's current accuracy bonus.
- float Function GetActionPointCost(Owner akOwner)
- Gets the object's current action point cost in VATS.
- Ammo Function GetAmmo(Owner akOwner)
- Gets the object's current ammo.
- int Function GetAmmoCapacity(Owner akOwner)
- Gets the object's ammo capacity.
- int Function GetArmorHealth(Owner akOwner)
- Gets the object's current armor health.
- int Function GetArmorRating(Owner akOwner)
- Gets the object's armor rating.
- int Function GetAttackDamage(Owner akOwner)
- Gets the object's attack damage.
- float Function GetAttackDelay(Owner akOwner)
- Gets the object's current attack delay.
- float Function GetCritChargeBonus(Owner akOwner)
- Gets the object's current critical charge bonus.
- float Function GetCritMultiplier(Owner akOwner)
- Gets the object's current critical multiplier.
- DamageTypeInfo[] Function GetDamageTypes(Owner akOwner)
- Gets the object's damage types, as an array.
- bool Function GetFlag(Owner akOwner, int flag)
- Gets the state of the passed flag on the object.
- int Function GetGoldValue(Owner akOwner)
- Gets the object's current gold (cap) value.
- Keyword[] Function GetKeywords(Owner akOwner)
- Gets the object's current keywords, as an array.
- float Function GetMaxRange(Owner akOwner)
- Gets the object's current max range.
- float Function GetMinRange(Owner akOwner)
- Gets the object's current min range.
- int Function GetNumProjectiles(Owner akOwner)
- Gets the object's current number of projectiles per shot.
- float Function GetOutOfRangeMultiplier(Owner akOwner)
- Gets the object's current out of range multiplier.
- Projectile Function GetProjectileOverride(Owner akOwner)
- Gets the object's current projectile override.
- float Function GetReach(Owner akOwner)
- Gets the object's current reach.
- float Function GetReloadSpeed(Owner akOwner)
- Gets the object's current reload speed.
- ActorValue Function GetResist(Owner akOwner)
- Gets the object's current resist ActorValue.
- float Function GetSightedTransition(Owner akOwner)
- Gets the object's current sighted transition time.
- ActorValue Function GetSkill(Owner akOwner)
- Gets the object's current skill ActorValue.
- float Function GetSpeed(Owner akOwner)
- Gets the object's current speed.
- int Function GetStagger(Owner akOwner)
- Gets the object's current stagger.
- float Function GetWeight(Owner akOwner)
- Gets the object's current weight.
- Function SetAccuracyBonus(Owner akOwner, int aiBonus)
- Sets the object's current accuracy bonus.
- Function SetActionPointCost(Owner akOwner, float afCost)
- Sets the object's current action point cost in VATS.
- Function SetAmmo(Owner akOwner, Ammo akAmmo)
- Sets the object's current ammo.
- Function SetAmmoCapacity(Owner akOwner, int aiCapacity)
- Sets the object's ammo capacity.
- Function SetArmorHealth(Owner akOwner, int aiHealth)
- Sets the object's current armor health.
- Function SetArmorRating(Owner akOwner, int aiRating)
- Sets the object's armor rating.
- Function SetAttackDamage(Owner akOwner, int aiDamage)
- Sets the object's attack damage.
- Function SetAttackDelay(Owner akOwner, float afDelay)
- Sets the object's current attack delay.
- Function SetCritChargeBonus(Owner akOwner, float afBonus)
- Sets the object's current critical charge bonus.
- Function SetCritMultiplier(Owner akOwner, float afMult)
- Sets the object's current critical multiplier.
- Function SetDamageTypes(Owner akOwner, DamageTypeInfo[] akDamageInfo)
- Sets the object's damage types, using an array.
- Function SetFlag(Owner akOwner, int flag, bool abSet)
- Sets the state of the passed flag on the object.
- Function SetGoldValue(Owner akOwner, int aiValue)
- Sets the object's current gold (cap) value.
- Function SetKeywords(Owner akOwner, Keyword[] akKeywords)
- Sets the object's current keywords, using an array.
- Function SetMaxRange(Owner akOwner, float afRange)
- Sets the object's current max range.
- Function SetMinRange(Owner akOwner, float afRange)
- Sets the object's current min range.
- Function SetNumProjectiles(Owner akOwner, int aiNumProj)
- Sets the object's current number of projectiles per shot.
- Function SetOutOfRangeMultiplier(Owner akOwner, float afMult)
- Sets the object's current out of range multiplier.
- Function SetProjectileOverride(Owner akOwner, Projectile akProj)
- Sets the object's current projectile override.
- Function SetReach(Owner akOwner, float afReach)
- Sets the object's current reach.
- Function SetReloadSpeed(Owner akOwner, float afSpeed)
- Sets the object's current reload speed.
- Function SetResist(Owner akOwner, ActorValue akResist)
- Sets the object's current resist ActorValue.
- Function SetSightedTransition(Owner akOwner, float afSeconds)
- Sets the object's current sighted transition time.
- Function SetSkill(Owner akOwner, ActorValue akSkill)
- Sets the object's current skill ActorValue.
- Function SetSpeed(Owner akOwner, float afSpeed)
- Sets the object's current speed.
- Function SetStagger(Owner akOwner, int aiStagger)
- Sets the object's current stagger.
- Function SetWeight(Owner akOwner, float afWeight)
- Sets the object's current weight.
Member Functions[edit | edit source]
None
F4SE Member Functions[edit | edit source]
None
Events[edit | edit source]
None