SetPedArmor: Difference between revisions

Revision as of 15:44, 11 September 2024

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

Syntax

bool setPedArmor ( ped thePed, float armor )

Armor bar on the hud

OOP Syntax Help! I don't understand this!

Method: ped:setArmor(...)

Variable: .armor

Counterpart: getPedArmor

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

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.

Example

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)

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 )

Requirements

This template will be deleted.

@@ Line 49: / Line 49: @@
 addCommandHandler( "addarmor", givePlayerArmor )
 </syntaxhighlight>
+==Requirements==
+{{Requirements|n/a|1.5.7-9.19626|}}
 ==See Also==
-{{Shared ped functions}}
+{{Ped functions}}
 [[ru:setPedArmor]]