bf6-portal-mod-types
    Preparing search index...

    Enumeration SoldierStateBool

    The SoldierStateBool enum.

    Index

    Enumeration Members

    HasBomb: number
    IsAISoldier: number

    Whether the soldier is an AI soldier.

    IsAlive: number

    Whether the soldier is alive. Appears to be the opposite of IsDead. Note that mod.UndeployPlayer will not kill the player, so this will remain true.

    IsBeingRevived: number

    Whether the soldier is being revived.

    IsCrouching: number

    Whether the soldier is crouching. It is true for the entire time you have instructed your character to crouch, even if you are not currently crouched or sliding, or if you ever will crouch or slide. For example, if while in the air you toggle (or hold) crouch on an off, it will be true for the entire time it was toggle on (or held).

    IsDead: number

    Whether the soldier is dead. Appears to be the opposite of IsAlive. Note that mod.UndeployPlayer will not kill the player, so this will remain false.

    IsDiving: number
    IsFiring: number

    Whether the soldier is firing. It is true for as long as it takes the weapon to animate firing, no matter how hard or long you press the trigger. If you rapidly fire semi-auto, it is true for every tick until you stop or run out of ammo. Trying to fire with no ammo does not result in this ever going true. Applies to anything (i.e. defibrillator, throwables, deployables), but not melee.

    IsInAir: number

    Whether the soldier is in the air.

    IsInteracting: number

    Whether the soldier is interacting with something. It is true for 1 tick when interacting with nothing, or with anything that does not need to be captured (i.e. a radio, door, etc). It is true for the entire time you are interacting with an MCOM.

    IsInVehicle: number

    Whether the soldier is in a vehicle.

    IsInWater: number

    Whether the soldier is in water.

    IsJumping: number

    Whether the soldier is jumping. It is true only for the entire time you are in the air as a result of a jump, not a vault (i.e. vaulting out of a window does not count).

    IsManDown: number

    Whether the soldier is man down.

    IsOnGround: number

    Whether the soldier is on the ground.

    IsParachuting: number

    Whether the soldier is parachuting. It is only true for the entire time your parachute is actually deployed.

    IsProne: number

    Whether the soldier is prone. It is true for the entire time you have instructed your character to prone or dive, even if you are not currently prone or diving, or if you ever will prone or dive. For example, if while in the air you toggle (or hold) prone on an off, it will be true for the entire time it was toggle on (or held).

    IsReloading: number

    Whether the soldier is reloading. It is only true for the entire time you are actually reloading (i.e. the
    reload animation for your weapon is playing).

    IsReviving: number

    Whether the soldier is reviving someone. It is only true for the entire time you are actually reviving someone. It is unclear if reviving with a defibrillator affects this.

    IsSprinting: number

    Whether the soldier is sprinting. It is only true for the time you are actually moving while sprinting. Can be as low as 1 tick.

    IsStanding: number

    Whether the soldier is standing.

    IsVaulting: number

    Whether the soldier is vaulting. It is only true for the entire time you're actually vaulting over or onto something (i.e. the animation of vaulting over an obstacle or grabbing and climbing up a ledge).

    IsZooming: number

    Whether the soldier is zooming. Is only true for the entire time you are actually aiming down sights. Can be as low as 1 tick. It is unclear if binoculars or vehicle views affect this.