SetVehicleHealth: Difference between revisions

From Onset Developer Wiki
No edit summary
No edit summary
Line 7: Line 7:
{{FuncParameters}}
{{FuncParameters}}
{{FuncParam|vehicle|The vehicle identifier}}
{{FuncParam|vehicle|The vehicle identifier}}
{{FuncParam|health|The vehicle health in float value between 0 to 5000.}}
{{FuncParam|health|The vehicle health in float value between 0 to 10000.}}


{{FuncReturnValue|This function '''true''' on success.}}
{{FuncReturnValue|This function '''true''' on success.}}

Revision as of 21:16, 1 December 2020

SetVehicleHealth

Type: Function
Context: Server
Introduced: v1.0

Description

Set the specified health for the specified vehicle.

Syntax

SetVehicleHealth(vehicle, health)

Parameters

  • vehicle
    The vehicle identifier
  • health
    The vehicle health in float value between 0 to 10000.

Return Value

  • This function true on success.

Example

AddCommand("vhealth", function(player, health)

	if (health == nil) then
		return AddPlayerChat(player, "Usage: /vhealth <health>")
	end

	health = tonumber(health)

	if (health == nil or health < 0.0 or health > 5000.0) then
		return AddPlayerChat(player, "Parameter \"health\" 0.0-5000.0")
	end

	local vehicle = GetPlayerVehicle(player)

	if (vehicle == 0) then
		return AddPlayerChat(player, "You must be in a vehicle")
	end

	if (GetPlayerVehicleSeat(player) ~= 1) then
		return AddPlayerChat(player, "You must be the driver of the vehicle")
	end

	local oldhealth = GetVehicleHealth(vehicle)
	SetVehicleHealth(vehicle, health)
	AddPlayerChat(player, "Old health: "..oldhealth..", new health: "..GetVehicleHealth(vehicle))
end)

See also

Retrieved from "https://dev.playonset.com/index.php?title=SetVehicleHealth&oldid=4524"