Difference between revisions of "InstanceData Script"
Jump to navigation
Jump to search
imported>ShadeMe (Add all global functions) |
imported>ShadeMe (Add all global functions, ordered, with correct argument names and descriptions.) |
||
Line 26: | Line 26: | ||
== F4SE Global Functions == | == F4SE Global Functions == | ||
*int Function [[GetAccuracyBonus - InstanceData|GetAccuracyBonus]](Owner akOwner) | *int Function [[GetAccuracyBonus - InstanceData|GetAccuracyBonus]](Owner akOwner) | ||
** | **Gets the object's current accuracy bonus. | ||
*float Function [[GetActionPointCost - InstanceData|GetActionPointCost]](Owner akOwner) | *float Function [[GetActionPointCost - InstanceData|GetActionPointCost]](Owner akOwner) | ||
** | **Gets the object's current action point cost in VATS. | ||
*Function [[ | |||
** | *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) | *float Function [[GetAttackDelay - InstanceData|GetAttackDelay]](Owner akOwner) | ||
** | **Gets the object's current attack delay. | ||
*Function [[ | |||
** | *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) | *float Function [[GetOutOfRangeMultiplier - InstanceData|GetOutOfRangeMultiplier]](Owner akOwner) | ||
** | **Gets the object's current out of range multiplier. | ||
*Function [[ | |||
** | *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) | *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. | |||
*float Function [[ | |||
** | *ActorValue Function [[GetSkill - InstanceData|GetSkill]](Owner akOwner) | ||
**Gets the object's current skill ActorValue. | |||
* | |||
** | |||
*float Function [[GetSpeed - InstanceData|GetSpeed]](Owner akOwner) | *float Function [[GetSpeed - InstanceData|GetSpeed]](Owner akOwner) | ||
** | **Gets the object's current speed. | ||
*int Function [[GetStagger - InstanceData|GetStagger]](Owner akOwner) | *int Function [[GetStagger - InstanceData|GetStagger]](Owner akOwner) | ||
** | **Gets the object's current stagger. | ||
*float Function [[GetWeight - InstanceData|GetWeight]](Owner akOwner) | *float Function [[GetWeight - InstanceData|GetWeight]](Owner akOwner) | ||
** | **Gets the object's current weight. | ||
*Function [[ | |||
** | *Function [[SetAccuracyBonus - InstanceData|SetAccuracyBonus]](Owner akOwner, int aiBonus) | ||
*int Function [[ | **Sets the object's current accuracy bonus. | ||
** | |||
*Function [[SetGoldValue - InstanceData|SetGoldValue]](Owner akOwner, int value) | *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) | ||
*Function [[ | **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 == |
Revision as of 20:10, 30 September 2017
Extends: ScriptObject
Script for the manipulation of object InstanceData.
Definition
ScriptName InstanceData Native Hidden
Properties
None
F4SE Structs
- Struct Owner
- A structure that holds information about an object's Owner.
- Struct DamageTypeInfo
- A structure that holds information about an object's Damage Types.
Global Functions
None
F4SE Global Functions
- 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
None
F4SE Member Functions
None
Events
None