Difference between revisions of "ObjectMod Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>ShadeMe
(Add missing F4SE member functions)
imported>Qazaaq
m
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:Papyrus]]
[[Category:Scripting]]
[[Category:Script Objects]]
[[Category:Items]]
'''Extends:''' [[Form Script]]
'''Extends:''' [[Form Script]]
 
<BR>
'''Editor:''' [[Object Mod]]
'''Editor:''' [[Object Mod]]


Script for the manipulation of an object mod
Script for the manipulation of an object modification.


== Definition ==
== Definition ==
Line 18: Line 14:


== F4SE Properties ==
== F4SE Properties ==
None
*TypeBool: Set of read-only properties that uses value1, and operators Set/And/Or.
**int Weapon_Target_bAlternateRumble: 22
**int Weapon_Target_bAutomatic: 25
**int Weapon_Target_bBoltAction: 81
**int Weapon_Target_bCantDrop: 26
**int Weapon_Target_bChargingAttack: 93
**int Weapon_Target_bChargingReload: 18
**int Weapon_Target_bDisableShells: 92
**int Weapon_Target_bEffectOnDeath: 21
**int Weapon_Target_bFixedRange: 20
**int Weapon_Target_bHasScope: 48
**int Weapon_Target_bHoldInputToPower: 85
**int Weapon_Target_bIgnoreResist: 24
**int Weapon_Target_bMinorCrime: 19
**int Weapon_Target_bNonHostile: 23
**int Weapon_Target_bNonPlayable: 27
**int Weapon_Target_bNPCsUseAmmo: 17
**int Weapon_Target_bPlayerOnly: 16
**int Weapon_Target_bRepeatableSingleFire: 86
 
*TypeInt: Set of read-only properties that uses value1, value2, and operators Set/Add/Mul-Add.
**int Actor_Target_iXPOffset: 514
**int Armor_Target_iHealth: 267
**int Armor_Target_iRating: 262
**int Armor_Target_iValue: 261
**int Weapon_Target_iAmmoCapacity: 12
**int Weapon_Target_iAttackDamage: 28
**int Weapon_Target_iRank: 10
**int Weapon_Target_iValue: 29
**int Weapon_Target_uAimModelConeDecreaseDelayMs: 37
**int Weapon_Target_uAimModelRecoilShotsForRunaway: 44
**int Weapon_Target_uNumProjectiles: 51
 
*TypeFloat: Set of read-only properties that uses value1, value2, and operators Set/Add/Mul-Add.
**int Actor_Target_fColorRemappingIndex: 516
**int Armor_Target_fColorRemappingIndex: 268
**int Armor_Target_fWeight: 260
**int Weapon_Target_fAimModelBaseStability: 66
**int Weapon_Target_fAimModelConeDecreasePerSec: 36
**int Weapon_Target_fAimModelConeIncreasePerShot: 35
**int Weapon_Target_fAimModelConeIronSightsMultiplier: 47
**int Weapon_Target_fAimModelConeSneakMultiplier: 38
**int Weapon_Target_fAimModelMaxConeDegrees: 34
**int Weapon_Target_fAimModelMinConeDegrees: 33
**int Weapon_Target_fAimModelRecoilArgDeg: 45
**int Weapon_Target_fAimModelRecoilArgRotateDeg: 46
**int Weapon_Target_fAimModelRecoilDiminishSightsMult: 40
**int Weapon_Target_fAimModelRecoilDiminishSpringForce: 39
**int Weapon_Target_fAimModelRecoilHipMult: 43
**int Weapon_Target_fAimModelRecoilMaxDegPerShot: 41
**int Weapon_Target_fAimModelRecoilMinDegPerShot: 42
**int Weapon_Target_fAttackActionPointCost: 79
**int Weapon_Target_fAttackDelaySec: 4
**int Weapon_Target_fColorRemappingIndex: 88
**int Weapon_Target_fCriticalChargeBonus: 8
**int Weapon_Target_fCriticalDamageMult: 90
**int Weapon_Target_fFireSeconds: 50
**int Weapon_Target_fFullPowerSeconds: 84
**int Weapon_Target_fMaxRange: 3
**int Weapon_Target_fMinPowerPerShot: 87
**int Weapon_Target_fMinRange: 2
**int Weapon_Target_fOutOfRangeDamageMult: 6
**int Weapon_Target_fReach: 1
**int Weapon_Target_fReloadSpeed: 76
**int Weapon_Target_fSecondaryDamage: 7
**int Weapon_Target_fSightedTransitionSeconds: 83
**int Weapon_Target_fSoundLevelMult: 74
**int Weapon_Target_fSpeed: 0
**int Weapon_Target_fUnused: 5
**int Weapon_Target_fWeight: 30
**int Weapon_Target_fZoomDataCameraOffsetX: 70
**int Weapon_Target_fZoomDataCameraOffsetY: 71
**int Weapon_Target_fZoomDataCameraOffsetZ: 72
 
*TypeForm: Set of read-only properties that uses object, and operators Set/Add/Rem.
**int Actor_Target_peEnchantments: 515
**int Actor_Target_piForcedInventory: 513
**int Actor_Target_pkKeywords: 512
**int Actor_Target_pwMaterialSwaps: 517
**int Armor_Target_peEnchantments: 256
**int Armor_Target_piBashImpactDataSet: 257
**int Armor_Target_pkKeywords: 259
**int Armor_Target_pmBlockMaterial: 258
**int Armor_Target_pwMaterialSwaps: 269
**int Weapon_Target_paAimModel: 32
**int Weapon_Target_peEnchantments: 65
**int Weapon_Target_pgZoomDataImageSpace: 69
**int Weapon_Target_piBashImpactDataSet: 63
**int Weapon_Target_piImpactDataSet: 60
**int Weapon_Target_pkKeywords: 31
**int Weapon_Target_plCritEffect: 62
**int Weapon_Target_pmBlockMaterial: 64
**int Weapon_Target_pnNPCAmmoList: 75
**int Weapon_Target_poAmmo: 61
**int Weapon_Target_ppOverrideProjectile: 80
**int Weapon_Target_psAttackFailSound: 55
**int Weapon_Target_psAttackLoop: 54
**int Weapon_Target_psAttackSound: 52
**int Weapon_Target_psAttackSound2D: 53
**int Weapon_Target_psEquipSound: 57
**int Weapon_Target_psFastEquipSound: 91
**int Weapon_Target_psIdleSound: 56
**int Weapon_Target_psUnEquipSound: 58
**int Weapon_Target_ptEquipSlot: 73
**int Weapon_Target_pwMaterialSwaps: 89
**int Weapon_Target_pzZoomData: 67
 
*TypeFormFloat: Set of read-only properties that uses object, value1, and operators Set/Add/Mul-Add.
**int Armor_Target_vaActorValues: 266
**int Armor_Target_vdDamageTypeValues: 265
**int Weapon_Target_vaActorValues: 94
**int Weapon_Target_vdDamageTypeValues: 77
 
*TypeEnum: Set of read-only properties that uses value1, and operator Set.
**int Weapon_Target_ehHitBehavior: 9
**int Weapon_Target_elSoundLevel: 59
**int Weapon_Target_eoZoomDataOverlay: 68
**int Weapon_Target_esStaggerValue: 82
**int Weapon_Target_ewType: 15
 
*TypeOperators: Set of read-only properties representing operators.
**int Modifier_Operator_Set: 0
**int Modifier_Operator_Add: 1
**int Modifier_Operator_Mult_Add: 2
**int Modifier_Operator_And: 3
**int Modifier_Operator_Or: 4
**int Modifier_Operator_Rem: 5


== F4SE Structs ==
== F4SE Structs ==
Line 39: Line 161:
*int Function [[GetPriority - ObjectMod|GetPriority]]()
*int Function [[GetPriority - ObjectMod|GetPriority]]()
**Gets the ObjectMod's priority.
**Gets the ObjectMod's priority.
*PropertyModifier[] Function [[GetPropertyModifiers - ObjectMod|GetPropertyModifiers]]()
**Gets the ObjectMod's property modifiers.


*Function [[SetMaxRank - ObjectMod|SetMaxRank]](int aiRank)
*Function [[SetMaxRank - ObjectMod|SetMaxRank]](int aiRank)
Line 45: Line 170:
*Function [[SetPriority - ObjectMod|SetPriority]](int aiPriority)
*Function [[SetPriority - ObjectMod|SetPriority]](int aiPriority)
**Sets the ObjectMod's priority.
**Sets the ObjectMod's priority.


== Events ==
== Events ==
Line 52: Line 176:
== See Also ==
== See Also ==
*[[:Category:Items|Items Category]]
*[[:Category:Items|Items Category]]
[[Category:Papyrus]]
[[Category:Scripting]]
[[Category:Script Objects]]
[[Category:Items]]

Latest revision as of 18:10, 21 January 2018

Extends: Form Script
Editor: Object Mod

Script for the manipulation of an object modification.

Definition[edit | edit source]

ScriptName ObjectMod extends Form Native Hidden

Properties[edit | edit source]

None

F4SE Properties[edit | edit source]

  • TypeBool: Set of read-only properties that uses value1, and operators Set/And/Or.
    • int Weapon_Target_bAlternateRumble: 22
    • int Weapon_Target_bAutomatic: 25
    • int Weapon_Target_bBoltAction: 81
    • int Weapon_Target_bCantDrop: 26
    • int Weapon_Target_bChargingAttack: 93
    • int Weapon_Target_bChargingReload: 18
    • int Weapon_Target_bDisableShells: 92
    • int Weapon_Target_bEffectOnDeath: 21
    • int Weapon_Target_bFixedRange: 20
    • int Weapon_Target_bHasScope: 48
    • int Weapon_Target_bHoldInputToPower: 85
    • int Weapon_Target_bIgnoreResist: 24
    • int Weapon_Target_bMinorCrime: 19
    • int Weapon_Target_bNonHostile: 23
    • int Weapon_Target_bNonPlayable: 27
    • int Weapon_Target_bNPCsUseAmmo: 17
    • int Weapon_Target_bPlayerOnly: 16
    • int Weapon_Target_bRepeatableSingleFire: 86
  • TypeInt: Set of read-only properties that uses value1, value2, and operators Set/Add/Mul-Add.
    • int Actor_Target_iXPOffset: 514
    • int Armor_Target_iHealth: 267
    • int Armor_Target_iRating: 262
    • int Armor_Target_iValue: 261
    • int Weapon_Target_iAmmoCapacity: 12
    • int Weapon_Target_iAttackDamage: 28
    • int Weapon_Target_iRank: 10
    • int Weapon_Target_iValue: 29
    • int Weapon_Target_uAimModelConeDecreaseDelayMs: 37
    • int Weapon_Target_uAimModelRecoilShotsForRunaway: 44
    • int Weapon_Target_uNumProjectiles: 51
  • TypeFloat: Set of read-only properties that uses value1, value2, and operators Set/Add/Mul-Add.
    • int Actor_Target_fColorRemappingIndex: 516
    • int Armor_Target_fColorRemappingIndex: 268
    • int Armor_Target_fWeight: 260
    • int Weapon_Target_fAimModelBaseStability: 66
    • int Weapon_Target_fAimModelConeDecreasePerSec: 36
    • int Weapon_Target_fAimModelConeIncreasePerShot: 35
    • int Weapon_Target_fAimModelConeIronSightsMultiplier: 47
    • int Weapon_Target_fAimModelConeSneakMultiplier: 38
    • int Weapon_Target_fAimModelMaxConeDegrees: 34
    • int Weapon_Target_fAimModelMinConeDegrees: 33
    • int Weapon_Target_fAimModelRecoilArgDeg: 45
    • int Weapon_Target_fAimModelRecoilArgRotateDeg: 46
    • int Weapon_Target_fAimModelRecoilDiminishSightsMult: 40
    • int Weapon_Target_fAimModelRecoilDiminishSpringForce: 39
    • int Weapon_Target_fAimModelRecoilHipMult: 43
    • int Weapon_Target_fAimModelRecoilMaxDegPerShot: 41
    • int Weapon_Target_fAimModelRecoilMinDegPerShot: 42
    • int Weapon_Target_fAttackActionPointCost: 79
    • int Weapon_Target_fAttackDelaySec: 4
    • int Weapon_Target_fColorRemappingIndex: 88
    • int Weapon_Target_fCriticalChargeBonus: 8
    • int Weapon_Target_fCriticalDamageMult: 90
    • int Weapon_Target_fFireSeconds: 50
    • int Weapon_Target_fFullPowerSeconds: 84
    • int Weapon_Target_fMaxRange: 3
    • int Weapon_Target_fMinPowerPerShot: 87
    • int Weapon_Target_fMinRange: 2
    • int Weapon_Target_fOutOfRangeDamageMult: 6
    • int Weapon_Target_fReach: 1
    • int Weapon_Target_fReloadSpeed: 76
    • int Weapon_Target_fSecondaryDamage: 7
    • int Weapon_Target_fSightedTransitionSeconds: 83
    • int Weapon_Target_fSoundLevelMult: 74
    • int Weapon_Target_fSpeed: 0
    • int Weapon_Target_fUnused: 5
    • int Weapon_Target_fWeight: 30
    • int Weapon_Target_fZoomDataCameraOffsetX: 70
    • int Weapon_Target_fZoomDataCameraOffsetY: 71
    • int Weapon_Target_fZoomDataCameraOffsetZ: 72
  • TypeForm: Set of read-only properties that uses object, and operators Set/Add/Rem.
    • int Actor_Target_peEnchantments: 515
    • int Actor_Target_piForcedInventory: 513
    • int Actor_Target_pkKeywords: 512
    • int Actor_Target_pwMaterialSwaps: 517
    • int Armor_Target_peEnchantments: 256
    • int Armor_Target_piBashImpactDataSet: 257
    • int Armor_Target_pkKeywords: 259
    • int Armor_Target_pmBlockMaterial: 258
    • int Armor_Target_pwMaterialSwaps: 269
    • int Weapon_Target_paAimModel: 32
    • int Weapon_Target_peEnchantments: 65
    • int Weapon_Target_pgZoomDataImageSpace: 69
    • int Weapon_Target_piBashImpactDataSet: 63
    • int Weapon_Target_piImpactDataSet: 60
    • int Weapon_Target_pkKeywords: 31
    • int Weapon_Target_plCritEffect: 62
    • int Weapon_Target_pmBlockMaterial: 64
    • int Weapon_Target_pnNPCAmmoList: 75
    • int Weapon_Target_poAmmo: 61
    • int Weapon_Target_ppOverrideProjectile: 80
    • int Weapon_Target_psAttackFailSound: 55
    • int Weapon_Target_psAttackLoop: 54
    • int Weapon_Target_psAttackSound: 52
    • int Weapon_Target_psAttackSound2D: 53
    • int Weapon_Target_psEquipSound: 57
    • int Weapon_Target_psFastEquipSound: 91
    • int Weapon_Target_psIdleSound: 56
    • int Weapon_Target_psUnEquipSound: 58
    • int Weapon_Target_ptEquipSlot: 73
    • int Weapon_Target_pwMaterialSwaps: 89
    • int Weapon_Target_pzZoomData: 67
  • TypeFormFloat: Set of read-only properties that uses object, value1, and operators Set/Add/Mul-Add.
    • int Armor_Target_vaActorValues: 266
    • int Armor_Target_vdDamageTypeValues: 265
    • int Weapon_Target_vaActorValues: 94
    • int Weapon_Target_vdDamageTypeValues: 77
  • TypeEnum: Set of read-only properties that uses value1, and operator Set.
    • int Weapon_Target_ehHitBehavior: 9
    • int Weapon_Target_elSoundLevel: 59
    • int Weapon_Target_eoZoomDataOverlay: 68
    • int Weapon_Target_esStaggerValue: 82
    • int Weapon_Target_ewType: 15
  • TypeOperators: Set of read-only properties representing operators.
    • int Modifier_Operator_Set: 0
    • int Modifier_Operator_Add: 1
    • int Modifier_Operator_Mult_Add: 2
    • int Modifier_Operator_And: 3
    • int Modifier_Operator_Or: 4
    • int Modifier_Operator_Rem: 5

F4SE Structs[edit | edit source]

  • Struct PropertyModifier
    • A structure that holds property information about an ObjectMod entry.

Global Functions[edit | edit source]

None

Member Functions[edit | edit source]

None

F4SE Member Functions[edit | edit source]

  • MiscObject Function GetLooseMod()
    • Gets the ObjectMod's loose mod.
  • int Function GetMaxRank()
    • Gets the ObjectMod's max rank.
  • int Function GetPriority()
    • Gets the ObjectMod's priority.
  • Function SetMaxRank(int aiRank)
    • Sets the ObjectMod's max rank.
  • Function SetPriority(int aiPriority)
    • Sets the ObjectMod's priority.

Events[edit | edit source]

None

See Also[edit | edit source]