GetVehicleIDFromName: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
Line 33: Line 33:
outputChatBox ( "A vehicle with an ID of "..carid.." was created!" )
outputChatBox ( "A vehicle with an ID of "..carid.." was created!" )
end
end
--If the entered car name returns no ID, the string will be empty and false will be returned.
--If the entered car name returns no car ID, the string will be empty and false will be returned.
--If the string does have any value, we announce it in the chatbox because it retrieved a vehicle ID,
--If the string does have any value, we create the car and announce the car ID in the chatbox,
--which means a car did exist under that name.
--because a car did exist under the given car name.
end
end
</syntaxhighlight>
</syntaxhighlight>

Revision as of 08:43, 11 April 2007

This function retrieves the ID of a vehicle as an integer value from its name.

Syntax

int getVehicleIDFromName ( string name )

Required Arguments

  • name: A string containing the name of the vehicle.

Returns

Returns an int if the name exists, false otherwise.

Example

This will allow the player to create a vehicle by name and it's ID will be displayed in the chatbox when the vehicle is spawned. 

addCommandHandler ( "spawnvehicle", "createvehiclecommand" )
function createvehiclecommand ( player, commandName, carname )
--This function is triggered by the text "spawncar" in the console.
--The player must also specify the added varible carname to specify
--what car they wish to spawn.
carid = getVehicleIDFromName ( carname )
--Get the ID of the car the player asked for and store it to the
--varible 'carid'
local x, y, z = getElementPosition ( player )
--Get the position of the player to spawn the car near this location
	if carid == false then
	outputChatBox ( "That is not a valid car name" )
	else
	createVehicle ( carid, x + 5, y, z )
	--Spawn the car using it's ID. Spawn it at x + 5 from the player so it doesn't crush him
	outputChatBox ( "A vehicle with an ID of "..carid.." was created!" )
	end
	--If the entered car name returns no car ID, the string will be empty and false will be returned.
	--If the string does have any value, we create the car and announce the car ID in the chatbox,
	--because a car did exist under the given car name.
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetVehicleIDFromName?oldid=7816"