Pair: getPedArmor

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

---

This function allows you to set the armor value of a ped. Function also added client-side.

OOP Syntax Help! I don't understand this!

• Method:ped:setArmor(...)
• Variable: .armor

Syntax

bool setPedArmor ( ped thePed, float armor )

Required Arguments

• thePed: the ped whose armor you want to modify.
• armor: the amount of armor you want to set on the ped. Valid values are from 0 to 100.

Returns

• bool: value

Returns true if the armor was changed succesfully. Returns false if an invalid ped was specified, or the armor value specified is out of acceptable range.

Code Examples

Example 1 Example 2

shared

This example removes the armor of a player.

function armor (player, command)
   if command == "addarmor" then
      setPedArmor ( player, 100 )    -- Set player's armor to 100 when he types the command 'addarmor'
   elseif command == "removearmor" then
      setPedArmor ( player, 0 )      -- Set player's armor to 0 when he types the command 'removearmor'
   end
end
addCommandHandler ("addarmor", armor)
addCommandHandler ("removearmor", armor)

shared

In this, adds an amount of armor that the player defined in command 'addarmor'.

function givePlayerArmor( player, command, amount )
   if getPedArmor(player) == 100 then
      outputChatBox("Your armor already is complete!", player, 220, 0, 0 ) -- Inform the player if your armor already is complete.
      return
   end

   if amount and tonumber(amount) >= 1 or tonumber(amount) <= 100 then -- If amount is between 1 and 100.
      setPedArmor(player, tonumber(amount))    -- Set amount armor that player chosen on the command.
   else
      outputChatBox( "Syntax: /addarmor [armor-amount] the amount should be between 1 and 100", player, 220, 0, 0 ) -- Inform the player if 'amount' argument is missing.
   end
end
addCommandHandler( "addarmor", givePlayerArmor )

See Also

Ped Functions

• addPedClothes
• canPedBeKnockedOffBike
• createPed
• getPedAmmoInClip
• getPedAnalogControlState
• getPedAnimation
• getPedArmor
• getPedBonePosition
• getPedCameraRotation
• getPedClothes
• getPedContactElement
• getPedControlState
• getPedFightingStyle
• getPedGravity
• getPedMoveState
• getPedOccupiedVehicle
• getPedOccupiedVehicleSeat
• getPedOxygenLevel
• getPedSimplestTask
• getPedStat
• getPedTarget
• getPedTargetCollision
• getPedTargetEnd
• getPedTargetStart
• getPedTask
• getPedTotalAmmo
• getPedVoice
• getPedWalkingStyle
• getPedWeapon
• getPedWeaponMuzzlePosition
• getPedWeaponSlot
• getValidPedModels
• givePedWeapon
• isPedBleeding
• isPedChoking
• isPedDead
• isPedDoingGangDriveby
• isPedDoingTask
• isPedDucked
• IsPedFootBloodEnabled
• isPedHeadless
• isPedInVehicle
• isPedOnGround
• isPedReloadingWeapon
• isPedTargetingMarkerEnabled
• isPedWearingJetpack
• killPed
• playPedVoiceLine
• reloadPedWeapon
• removePedClothes
• removePedFromVehicle
• resetPedVoice
• setPedAimTarget
• setPedAnalogControlState
• setPedAnimation
• setPedAnimationProgress
• setPedAnimationSpeed
• setPedArmor
• setPedBleeding
• setPedCameraRotation
• setPedCanBeKnockedOffBike
• setPedChoking
• setPedControlState
• setPedDoingGangDriveby
• setPedEnterVehicle
• setPedExitVehicle
• setPedFightingStyle
• setPedFootBloodEnabled
• setPedGravity
• setPedHeadless
• setPedLookAt
• setPedOxygenLevel
• setPedStat
• setPedTargetingMarkerEnabled
• setPedVoice
• setPedWalkingStyle
• setPedWeaponSlot
• setPedWearingJetpack
• warpPedIntoVehicle

Ped Events

• onClientPedChoke
• onClientPedDamage
• onClientPedHeliKilled
• onClientPedHitByWaterCannon
• onClientPedStep
• onClientPedVehicleEnter
• onClientPedVehicleExit
• onClientPedWasted
• onClientPedWeaponFire
• onPedDamage
• onPedVehicleEnter
• onPedVehicleExit
• onPedWasted
• onPedWeaponSwitch

Reference

• Scripting Functions