modwright 0.1.0

package/knowledge/cyberpunk2077/drones.combat.yaml

@@ -0,0 +1,416 @@
+game: cyberpunk2077
+topic: drones.combat
+title: How a drone shoots - its AI shoot actions and their gates, the context-free script shot, and
+  the drone aim rig
+facts:
+  - id: cp2077.drones.combat.octant-shoot-chain
+    claim: "An Octant shoots through its action map: Character.Drone_Octant_Base sets actionMap
+      DroneOctantArchetype.Map and equips Items.Octant_Autocannon into AttachmentSlots.WeaponRight
+      as primaryEquipment; the map overrides GenericArchetype.ShootDefault with
+      DroneOctantActions.ShootDefault, whose single loop sub-action is an AISubActionShootWithWeapon
+      on AttachmentSlots.WeaponRight at AIActionTarget.CombatTarget with numberOfShots 20. The
+      sub-action resolves the weapon through TransactionSystem.GetItemInSlot and every shot ends in
+      the static AIWeapon.Fire."
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\tweaks\base\gameplay\static_data\database\characters\bases\base_records.tweak:290,
+      :297, :299-307; ...\ai\actions\packages\drone\droneoctant.tweak:30-33, :189;
+      ...\ai\actions\library\droneoctantactions.tweak:1193, :1244-1271;
+      tools\redmod\scripts\core\ai\actions\tweakAISubActions.script:3349, :3086, :3117
+    tags:
+      - drone
+      - octant
+      - shooting
+      - aisubactionshootwithweapon
+      - weaponright
+      - actionmap
+  - id: cp2077.drones.combat.octant-shoot-gates
+    claim: "DroneOctantActions.ShootDefault's activationCondition is an AND of five terms a humanoid's
+      shoot action does not carry: Condition.TargetBelow35deg (AISpatialCond coneAngle (-1, 35)),
+      OR(TargetUpTo6dot5mZDiff zDiff (0,6.5), TargetAbove15m distance (15,-1)), OR(TargetIsVisible
+      isVisible=1, IsNPCBlinded), MaxVisibilityToTargetDistance3m (the senses visibility trace must
+      end within 3 m of the target) and NotFriendlyFire. The Wyvern's DroneActions.ShootDefault is
+      the same shape with TargetBelow15deg, 3.5 m zDiff or 6 m and OptimalDistance10mTolerance."
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\tweaks\base\gameplay\static_data\database\ai\actions\library\droneoctantactions.tweak:1195-1215;
+      ...\library\commonconditionchecks.tweak:10340, :10665, :9637, :5545, :1382, :5690, :6944;
+      ...\library\droneactions.tweak:226-280;
+      tools\redmod\scripts\core\ai\actions\tweakAIConditionChecks.script:2771-2788
+    tags:
+      - drone
+      - octant
+      - wyvern
+      - shooting
+      - aiaction
+      - conditions
+      - visibility
+  - id: cp2077.drones.combat.humanoid-shoot-gates-differ
+    claim: A humanoid's ShootActions.ShootDefault gates only on ValidTargetOrAimCommandCondition
+      (not-invalid-expectation AND MinAccuracyValue0, minAccuracyValue 0.001, or an aim command) and
+      ShootActivationCondition (AbilityCanShootWhileMoving AND TargetBelow270deg), and takes an
+      AITicketType.Shoot ticket. It asks for no target visibility, no cone below 35 degrees and no
+      height difference, which is why an injected threat with accuracy 1.0 is enough to make a human
+      shoot and not enough for a drone.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\tweaks\base\gameplay\static_data\database\ai\actions\library\shootingactions.tweak:439-444;
+      ...\library\commonconditionchecks.tweak:851-863, :1016-1022, :5511, :5649
+    tags:
+      - shooting
+      - aiaction
+      - conditions
+      - humanoid
+      - ticket
+  - id: cp2077.drones.combat.senses-off-blocks-drone-shoot
+    claim: "A script that turns a puppet's SenseComponent off (ToggleComponent(false)) and then only
+      injects a threat can make a humanoid shoot but not a drone: the drone's shoot action requires
+      OR(TargetIsVisible, IsNPCBlinded) and MaxVisibilityToTargetDistance3m, both of which read the
+      sense component, while the humanoid's requires neither. This is the leading explanation for a
+      quickhack mod's (v0.8.3) Fire() being inert on an Octant (suppression mask 30, bit 2 = senses
+      off) while it works on an android."
+    status: inferred
+    source: ModWright research
+    related:
+      - id: cp2077.drones.combat.octant-shoot-gates
+      - id: cp2077.drones.combat.humanoid-shoot-gates-differ
+    tags:
+      - drone
+      - shooting
+      - senses
+      - suppression
+  - id: cp2077.drones.combat.aiweapon-fire-static
+    claim: AIWeapon.Fire(weaponOwner, weapon, timeStamp, tbhCoefficient, requestedTriggerMode, optional
+      targetPosition, target, rangedAttack, maxSpreadOverride, aimingDelay, offset,
+      shouldTrackTarget, predictionTime, posProviderOverride, muzzleOffset, weaponCustomEvent) is a
+      public static on abstract class AIWeapon that takes no ScriptExecutionContext and no AI
+      component. It is what every AI shoot sub-action ends in, so script can call it directly to
+      fire a puppet's weapon without the behaviour tree. Its only early returns are a missing or
+      unattached weapon and an overheated one.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\scripts\cyberpunk\items\weapon.script:1516, :1845, :1870, :1874-1881;
+      core\ai\actions\tweakAISubActions.script:3117
+    tags:
+      - shooting
+      - aiweapon
+      - weaponobject
+      - script-entry-point
+      - no-behaviour-tree
+  - id: cp2077.drones.combat.aiweapon-fire-branches
+    claim: AIWeapon.Fire picks its shot three ways. With a target object it needs
+      weaponOwner.GetSensesComponent().IsAgentVisible(target) (or shouldTrackTarget) before it
+      builds a position provider on the target's best shooting component and applies the victim's
+      targetShootComponent. With target null and a targetPosition it builds a static position
+      provider at that point. It then calls the native WeaponObject.AI_ShootAt when
+      AIActionHelper.ShouldShootDirectlyAtTarget or TargetTrackerComponent.IsPositionValid accepts
+      the point, and otherwise falls through to WeaponObject.AI_ShootForwards along the weapon's own
+      forward - so the position form always produces a shot and never touches the sense component.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\scripts\cyberpunk\items\weapon.script:1915-1956, :1980-1996, :143-144;
+      core\ai\actions\aiActionHelper.script:148-169;
+      core\components\targetTrackingComponent.script:256
+    related:
+      - id: cp2077.drones.combat.aiweapon-fire-static
+    tags:
+      - shooting
+      - aiweapon
+      - ai-shootat
+      - ai-shootforwards
+      - positionprovider
+  - id: cp2077.drones.combat.forceshoot-command-limits
+    claim: AIForceShootCommand carries only targetOverrideNodeRef (NodeRef), targetOverridePuppetRef
+      (EntityReference, itself only a NodeRef) and duration, and its ForceShootCommandTask resolves
+      that reference and then calls AIActionHelper.SetCommandCombatTarget, which returns false on a
+      null target and cancels the command. So the command can only name a node-ref'd entity or
+      "#player", it needs the behaviour tree to be ticking, and it is unusable for an arbitrary or
+      spawned NPC target. AIAimAtTargetCommand has the same fields and the same handler shape, and
+      only aims.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\scripts\core\ai\aiCommand.script:572-578, :604-610;
+      cyberpunk\ai\commands\aiForceShootCommand.script:61-85;
+      cyberpunk\ai\commands\aiAimWithWeaponCommand.script:4-80;
+      core\ai\actions\aiActionHelper.script:295-316; core\systems\questSystem.script:10-13, :40-65
+    tags:
+      - shooting
+      - aiforceshootcommand
+      - aiaimattargetcommand
+      - entityreference
+      - noderef
+  - id: cp2077.drones.combat.forceshoot-bypasses-drone-gates
+    claim: The Octant's map routes GenericArchetype.CommandForceShoot to
+      DroneOctantActions.CommandForceShoot, which inherits ShootDefault but replaces its activation
+      with Condition.NotAIHoldPositionCommand alone, and ShootDefault's pause and to-next-phase
+      conditions each guard their not-visible term with Condition.NotAIForceShootCommand. So an
+      AIForceShootCommand makes a drone shoot through all five of its spatial and visibility gates,
+      including at a target it cannot see.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\tweaks\base\gameplay\static_data\database\ai\actions\packages\drone\droneoctant.tweak:50-53,
+      :213; ...\ai\actions\library\droneoctantactions.tweak:1233-1242, :1253-1269, :1306-1322;
+      ...\ai\actions\library\commonconditionchecks.tweak:6979-6990
+    related:
+      - id: cp2077.drones.combat.forceshoot-command-limits
+    tags:
+      - drone
+      - octant
+      - aiforceshootcommand
+      - conditions
+  - id: cp2077.drones.combat.shoot-subaction-needs-context
+    claim: Every entry point of AISubActionShootWithWeapon_Record_Implementation - Activate, Update,
+      Shoot and ShootToPoints - takes a ScriptExecutionContext, which exists only inside a running
+      behaviour tree, so none of them is callable from a mod. ShootToPoints is only a loop that
+      calls Shoot per world coordinate, and Shoot is only a wrapper over AIWeapon.Fire, so the
+      context-free equivalent of "shoot at a point" is AIWeapon.Fire with a targetPosition.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\scripts\core\ai\actions\tweakAISubActions.script:2928, :2979, :3117, :3164-3205
+    tags:
+      - shooting
+      - aisubactionshootwithweapon
+      - shoottopoint
+      - scriptexecutioncontext
+  - id: cp2077.drones.combat.drone-animgraph-has-no-aim-feature
+    claim: All four drone chassis use base\gameplay\anim_graphs\drone_humanoid.animgraph (from
+      archive\pc\content\basegame_3_nightcity.archive). Serialized, its declared anim features are
+      AnimFeature_DroneProcedural, AnimFeature_DroneActionAltitudeOffset,
+      AnimFeature_DroneStateAnimationData, animAnimFeature_DroneLocomotion,
+      AnimFeature_NPCUpperBodyState, AnimFeature_NPCStanceState and the status-effect, hit-reaction,
+      mounting and workspot ones - there is no AnimFeature_Aim and no AnimFeature_BasicAim. A
+      drone's aim is the LookAt system, not an anim feature.
+    status: verified
+    verified_on: "2.31"
+    source: base\gameplay\anim_graphs\drone_humanoid.animgraph serialized to JSON (its animAnimFeature*
+      and AnimFeature_* type names)
+    tags:
+      - drone
+      - animgraph
+      - animfeature
+      - aim
+      - lookat
+  - id: cp2077.drones.combat.drone-lookat-parts
+    claim: "The drone animgraph declares six animLookAtPartInfo parts - DroneHorizontal and
+      DroneHighSpeedHorizontal on the target bone pla_horizontal_tgt, DroneVertical and
+      DroneHighSpeedVertical on pla_vertical_tgt, DroneWeapons and DroneHighSpeedWeapons on
+      pla_weapons_tgt - and those target bones drive animAnimNode_AimConstraint chains whose blend
+      weight is a float input in the group DroneWeapons named blendWeight, with the gun bone
+      frontGun01_JNT as the weapons chain's source. Vanilla drives them from an AI action's lookats:
+      LookatPreset.DroneHorizontal and DroneVertical at the threat's Head slot and
+      LookatPreset.DroneWeapons at its Chest, whose records are bodyPart DroneHorizontal /
+      DroneVertical / DroneWeapons with 360, 80 and 360 degree limits."
+    status: verified
+    verified_on: "2.31"
+    source: base\gameplay\anim_graphs\drone_humanoid.animgraph serialized (animLookAtPartInfo,
+      animAnimNode_AimConstraint);
+      tools\redmod\tweaks\base\gameplay\static_data\database\ai\actions\library\droneoctantactions.tweak:1280-1303;
+      ...\lookat_presets\base_values.tweak:1404, :1416, :1428
+    tags:
+      - drone
+      - lookat
+      - aim
+      - droneweapons
+      - animgraph
+      - frontgun01_jnt
+  - id: cp2077.drones.combat.lookatevent-from-script
+    claim: A LookAtAddEvent (extends AnimTargetAddEvent) carries a bodyPart CName plus
+      SetStaticTarget(worldPos), SetEntityTarget(entity, slotName, offset), SetPositionProvider,
+      SetLimits, SetStyle, SetAdditionalPartsArray and a request struct with priority; the vanilla
+      preset path only fills those fields from a LookAtPreset record and QueueEvents it on the
+      owner. So script can point a drone's guns by queueing a LookAtAddEvent with bodyPart =
+      n"DroneWeapons" and a static world target, with no AI and no behaviour tree.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\scripts\core\events\lookAtEvents.script:111-154, :180, :261-277
+    related:
+      - id: cp2077.drones.combat.drone-lookat-parts
+    tags:
+      - lookat
+      - lookataddevent
+      - aim
+      - script-entry-point
+  - id: cp2077.drones.combat.octant-weapon-slot-and-components
+    claim: The Octant template's Item_Attachment_Slot binds WeaponRight to the bone frontGun01_JNT (and
+      Head to the root bone base), and the template carries a gameSourceShootComponent named
+      sourceShootComponent - the component GameObject requests as 'sourceShootComponent' and returns
+      from GetSourceShootComponent, used for the line-of-sight queries behind the shooting
+      conditions. ScriptedPuppet.GetWeaponRight(obj) is a public static that returns the
+      WeaponObject in that slot.
+    status: verified
+    verified_on: "2.31"
+    source: ep1\vehicles\special\av_zetatech_octant__basic_01_ep1.ent (entSlotComponent
+      Item_Attachment_Slot; component list); tools\redmod\scripts\core\entity\gameObject.script:453,
+      :3092; cyberpunk\puppet\scriptedPuppet.script:2284
+    tags:
+      - drone
+      - octant
+      - weaponright
+      - frontgun01_jnt
+      - sourceshootcomponent
+      - slots
+  - id: cp2077.drones.combat.octant-autocannon-record
+    claim: 'Items.Octant_Autocannon is an ordinary bullet weapon - entityName "octant_autocannon",
+      triggerModes [TriggerMode.FullAuto], rangedAttacks Attacks.PhysicalBulletPackage,
+      placementSlots [AttachmentSlots.WeaponRight], shooting pattern package
+      ShootingPatterns.OctantAutocannonShootingPackage, canDrop false, NPC handling stats CycleTime
+      0.21 s and 3 shots in a burst. The Bombus is the chassis that differs: its fast and slow
+      packages point ShootDefault at DroneBombusActions.ShootBeam and its suicide package at
+      CommitSuicide.'
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\tweaks\base\gameplay\static_data\database\items\weapons\ranged\custom\drone_weapons\octant_autocannon.tweak:5-50;
+      ...\ai\actions\packages\drone\dronebombusfast.tweak:205;
+      ...\ai\actions\packages\drone\dronebombussuicide.tweak:109
+    tags:
+      - drone
+      - octant
+      - bombus
+      - weapon
+      - autocannon
+      - triggermode
+      - beam
+  - id: cp2077.drones.combat.redmod-tweak-sources-on-disk
+    claim: The whole vanilla TweakDB ships as readable .tweak text under <install>\tools\redmod\tweaks\,
+      so every AI action map, AI action, sub-action, condition, lookat preset, character base and
+      item record can be cited by file and line instead of only by record name through an index. The
+      AI action library is under base\gameplay\static_data\database\ai\actions\ (library\ for the
+      definitions, packages\ for the per-archetype maps).
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\tweaks\base\gameplay\static_data\database\ai\actions\packages\drone\droneoctant.tweak:1-4
+      (the file ModWright's lookup named as the occurrence of DroneOctantArchetype.Map)
+    tags:
+      - toolchain
+      - redmod
+      - tweakdb
+      - sources
+      - provenance
+  - id: cp2077.drones.combat.fire-falls-back-to-the-barrel-with-the-ai-off
+    claim: AIWeapon.Fire with a target position but no target object shoots at the position only if
+      AIActionHelper.ShouldShootDirectlyAtTarget or the owner's
+      TargetTrackerComponent.IsPositionValid passes; otherwise it calls AI_ShootForwards, down the
+      barrel. With the drone's AI off the tracker rejects the position, so a script shot flies
+      straight out of the barrel. Calling the weapon's own AI_ShootAt with
+      IPositionProvider.CreateStaticPositionProvider skips the checks.
+    status: verified
+    verified_on: "2.31"
+    source: tools\redmod\scripts\cyberpunk\items\weapon.script:1845-2000 (AIWeapon.Fire), :143-144
+      (AI_ShootAt, AI_ShootForwards); core\ai\actions\aiActionHelper.script:148-169
+    tags:
+      - drone
+      - fire
+      - weapon
+      - aim
+      - ai-off
+    related:
+      - cp2077.drones.combat.shoot-subaction-needs-context
+  - id: cp2077.drones.combat.a-drone-taken-at-spawn-has-no-weapon
+    claim: "A drone spawned and taken over at once has nothing in AttachmentSlots.WeaponRight: its AI
+      equips the record's primary equipment in the tree's EnterIdle, which never ran. Giving the
+      item (TransactionSystem.GiveItem) and mounting it (AddItemToSlot in the NPCEquipmentItem's
+      equipSlot) arms it; the Wyvern's is Items.Wyvern_Rifle."
+    status: verified
+    verified_on: "2.31"
+    source: ModWright field verification
+    tags:
+      - drone
+      - weapon
+      - equip
+      - spawn
+      - wyvern
+  - id: cp2077.drones.combat.wyvern-own-locomotion-is-slow
+    claim: "The Arasaka Wyvern drone's own walk movement parameters are 2 m/s top speed and 2.4 m/s^2
+      acceleration: flown on them it is \"definitely sluggish\". Walk 8, run 20 m/s, acceleration 60
+      and a release brake of 20 m/s^2 were accepted by hand for a script-flown Wyvern."
+    status: verified
+    verified_on: "2.31"
+    source: ModWright field verification
+    tags:
+      - drone
+      - wyvern
+      - locomotion
+      - speed
+      - tuning
+  - id: cp2077.drones.combat.npc-shots-on-friends-deal-no-damage
+    claim: "An NPC-instigated hit (a script-flown drone's shot) on an NPC Friendly to the instigator is
+      flagged DealNoDamage 'FriendlyFireIgnored' after the damage is computed: a spawned Arasaka
+      Wyvern is Friendly to the Maelstrom gangs, so its hits drew blood and did nothing. The
+      instigator's BaseStatusEffect.DoNotBlockShootingOnFriendlyFire lifts it. The victim still does
+      not react: AIActionHelper TryChangingAttitudeToHostile returns false for a Friendly attacker,
+      so turning the victim and each squadmate hostile toward the drone
+      (AttitudeAgent.SetAttitudeTowards) and injecting the drone as their threat
+      (TargetTrackingExtension.InjectThreat) is needed; then \"the entire squad attacked\"."
+    status: verified
+    verified_on: "2.31"
+    source: ModWright field verification
+    tags:
+      - drone
+      - damage
+      - friendly-fire
+      - attitude
+      - squad
+  - id: cp2077.drones.combat.wyvern-rifle-is-a-smart-weapon
+    claim: Items.Wyvern_Rifle is a smart weapon (WeaponEvolution.Smart, ranged attack
+      Attacks.SmartBulletDronePackage); fired without a lock its bullets curve side to side, and the
+      twin guns fire as a pair on the AIWeapon.Fire path. Its NPC damage comes from its npcRPGData
+      (BaseStats.DPS 40), not from the weapon's PhysicalDamage stat (0 on both a hand-given and an
+      AI-equipped rifle); its CycleTime is 0.9 s.
+    status: verified
+    verified_on: "2.31"
+    source: ModWright field verification
+    tags:
+      - drone
+      - wyvern
+      - smart
+      - weapon
+  - id: cp2077.drones.combat.drone-own-locomotion-by-size
+    claim: "The drones' own walk parameters: Wyvern and Griffin 2 m/s at 2.4 m/s^2, the Octant 3.5 m/s
+      at 20 m/s^2. Flown by script, the values accepted by hand were the Wyvern at walk 8, run 20,
+      acceleration 60, brake 20; the Griffin at 6, 12, 58, 18; the Octant on its own."
+    status: verified
+    verified_on: "2.31"
+    source: ModWright field verification
+    tags:
+      - drone
+      - locomotion
+      - tuning
+      - griffin
+      - octant
+      - wyvern
+  - id: cp2077.drones.combat.vanilla-smart-tracking-needs-the-weapons-lock
+    claim: "Vanilla AI guides a smart weapon's shot only when the weapon reports a native lock:
+      AISubActionShootWithWeapon passes shouldTrackTarget = (the weapon's evolution is Smart) and
+      weapon.IsTargetLocked(), a native lock the AI's aiming sets. A script shot with the AI off
+      never has that lock; forcing smartGunIsProjectileGuided and a trackedTargetComponent guides
+      the bullets to the component given (the best shooting component from above can be a leg's;
+      every human carries Targeting_Chest and Targeting_Head)."
+    status: verified
+    verified_on: "2.31"
+    source: core\ai\actions\tweakAISubActions.script:3117-3138; cyberpunk\items\weapon.script:134;
+      gang__ep1_maelstrom_ma.ent's gameTargetingComponent names
+    tags:
+      - drone
+      - smart
+      - weapon
+      - lock
+      - tracking
+    related:
+      - cp2077.drones.combat.fire-falls-back-to-the-barrel-with-the-ai-off
+      - cp2077.drones.combat.wyvern-rifle-is-a-smart-weapon
+  - id: cp2077.drones.combat.a-hit-animation-swings-a-flown-drones-view
+    claim: "A script-flown drone's view swings against its controls for a few seconds after it is hit
+      (forward and back, or left and right, swapped): the hit animation turns the drone's animated
+      skeleton, whose slot carries the camera, while the hull orientation the script moves by keeps
+      its heading. Toggling the HitReactionComponent off does not stop it; the animation is
+      requested from the damage pipeline (NPCPuppet.OnHitAnimation, gated by
+      ShouldRequestHitReaction)."
+    status: inferred
+    verified_on: "2.31"
+    source: ModWright research
+    tags:
+      - drone
+      - hit
+      - animation
+      - camera
+      - controls