GetVehicleModelFromName - Revision history

LordHenry: /* Required Arguments */

2017-05-26T19:53:28Z

Required Arguments

← Older revision		Revision as of 19:53, 26 May 2017
Line 10:		Line 10:
	===Required Arguments===		===Required Arguments===
	*'''name:''' A [[string]] containing the name of the vehicle.		*'''name:''' A [[string]] containing the name of the vehicle.
			{{All Vehicle Types}}

	===Returns===		===Returns===

Strix: add oop syntax

2015-01-02T19:04:16Z

add oop syntax

← Older revision		Revision as of 19:04, 2 January 2015
Line 7:		Line 7:
	int getVehicleModelFromName ( string name )		int getVehicleModelFromName ( string name )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|This function is a static function underneath the Vehicle class.\|[[Vehicle]].getModelFromName}}
	===Required Arguments===		===Required Arguments===
	*'''name:''' A [[string]] containing the name of the vehicle.		*'''name:''' A [[string]] containing the name of the vehicle.

Strix: Undo revision 43395 by Strix (talk)

2014-12-18T23:22:10Z

Undo revision 43395 by Strix (talk)

← Older revision		Revision as of 23:22, 18 December 2014
Line 7:		Line 7:
	int getVehicleModelFromName ( string name )		int getVehicleModelFromName ( string name )
	</syntaxhighlight>		</syntaxhighlight>
	~~{{OOP\|\|[[vehicle]]:getModelFromName}}~~
	===Required Arguments===		===Required Arguments===
	*'''name:''' A [[string]] containing the name of the vehicle.		*'''name:''' A [[string]] containing the name of the vehicle.

Strix: Does we really need this method?

2014-12-18T22:42:38Z

Does we really need this method?

← Older revision		Revision as of 22:42, 18 December 2014
Line 7:		Line 7:
	int getVehicleModelFromName ( string name )		int getVehicleModelFromName ( string name )
	</syntaxhighlight>		</syntaxhighlight>
			{{OOP\|\|[[vehicle]]:getModelFromName}}
	===Required Arguments===		===Required Arguments===
	*'''name:''' A [[string]] containing the name of the vehicle.		*'''name:''' A [[string]] containing the name of the vehicle.

Jaysds1: /* Example */ This example is server-sided because of the "thePlayer" variable in the function brackets

2013-06-16T17:03:27Z

Example: This example is server-sided because of the "thePlayer" variable in the function brackets

← Older revision		Revision as of 17:03, 16 June 2013
Line 16:		Line 16:

	==Example==		==Example==
			<section class="server" name="Server">
	This will allow the player to create a vehicle by name and it's model ID will be displayed in the chatbox when the vehicle is spawned.		This will allow the player to create a vehicle by name and it's model ID will be displayed in the chatbox when the vehicle is spawned.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 40:		Line 41:
	addCommandHandler ( "spawnvehicle", createVehicleCommand )		addCommandHandler ( "spawnvehicle", createVehicleCommand )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Vehicle functions}}		{{Vehicle functions}}

Awwu at 15:54, 3 April 2009

2009-04-03T15:54:37Z

← Older revision		Revision as of 15:54, 3 April 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{server client function}}		{{server client function}}
	This function retrieves the model ID of a vehicle as an [[~~integer~~]] value from its name.		This function retrieves the model ID of a vehicle as an [[int]]eger value from its name.

	==Syntax==		==Syntax==

Awwu: New page: NOTOC {{server client function}} This function retrieves the model ID of a vehicle as an integer value from its name. ==Syntax== int getVehicleModelFromName ( stri...

2009-04-03T15:54:19Z

New page: __NOTOC__ {{server client function}} This function retrieves the model ID of a vehicle as an integer value from its name. ==Syntax== <syntaxhighlight lang="lua"> int getVehicleModelFromName ( stri...

New page

__NOTOC__
{{server client function}}
This function retrieves the model ID of a vehicle as an [[integer]] value from its name.

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleModelFromName ( string name )
</syntaxhighlight>

===Required Arguments===
*'''name:''' A [[string]] containing the name of the vehicle.

===Returns===
Returns an [[int]]eger if the name exists, ''false'' otherwise.
If you use this function on vehicles with shared names, such as "police", it will return the earliest occurrence of that vehicle's ID.

==Example==
This will allow the player to create a vehicle by name and it's model ID will be displayed in the chatbox when the vehicle is spawned.
<syntaxhighlight lang="lua">
function createVehicleCommand ( thePlayer, commandName, carName )
-- This function is triggered by the text "spawnvehicle" in the console.
-- The player must specify the added parameter 'carName' to specify
-- what car they wish to spawn.
local carModel = getVehicleModelFromName ( carName )
-- Get the model ID of the car the player asked for and store it to the
-- variable 'carModel'
local x, y, z = getElementPosition ( thePlayer )
-- Get the position of the player to spawn the car near this location
if not carModel then
outputChatBox ( "That is not a valid car name" )
else
createVehicle ( carModel, x + 5, y, z )
-- Spawn the car using its model ID. Spawn it at x + 5 from the player so it doesn't crush him
outputChatBox ( "A vehicle with model ID of " .. carModel .. " was created!" )
end
-- If the entered car name returns no car model 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 model ID in the chatbox,
-- because a car did exist under the given car name.
end
addCommandHandler ( "spawnvehicle", createVehicleCommand )
</syntaxhighlight>

==See Also==
{{Vehicle functions}}