SpawnVehicle: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(16 intermediate revisions by 10 users not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool spawnVehicle ( vehicle theVehicle, float x, float y, float z, float rx, float ry, float rz )
bool spawnVehicle ( vehicle theVehicle, float x, float y, float z [, float rx, float ry, float rz ] )
</syntaxhighlight>  
</syntaxhighlight>  
 
{{OOP||[[vehicle]]:spawn}}
===Required Arguments===  
===Required Arguments===  
*'''theVehicle:''' The vehicle you wish to spawn
*'''theVehicle:''' The vehicle you wish to spawn
Line 13: Line 13:
*'''y:''' The x position you wish to spawn the vehicle at
*'''y:''' The x position you wish to spawn the vehicle at
*'''z:''' The x position you wish to spawn the vehicle at
*'''z:''' The x position you wish to spawn the vehicle at
===Optional Arguments===
{{OptionalArg}}
*'''rx:''' The x rotation you wish to spawn the vehicle at
*'''rx:''' The x rotation you wish to spawn the vehicle at
*'''ry:''' The y rotation you wish to spawn the vehicle at
*'''ry:''' The y rotation you wish to spawn the vehicle at
Line 20: Line 23:
Returns ''true'' if the vehicle spawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.
Returns ''true'' if the vehicle spawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
<section name="Server" class="server" show="true">
This example does...
With this feature, we spawn vehicle
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">function myCommandHandler(thePlayer, command)
<syntaxhighlight lang="lua">
local x, y, z = getElementPosition(thePlayer)
--This line does...
local RaceVehicle = createVehicle ( 411, 0, 0, 0 )
blabhalbalhb --abababa
local spawnVeh = spawnVehicle ( RaceVehicle, x+3, y+3, z )
--This line does this...
if spawnVeh then outputChatBox("Vehicle was spawned", thePlayer) else outputChatBox("Error",thePlayer) end
mooo
end
 
addCommandHandler("spawnvehicle", myCommandHandler)
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==Related scripting functions==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{Vehicle_functions|server}}
{{Vehicle functions}}
[[Category:Incomplete]]

Latest revision as of 23:05, 6 September 2024

Spawns a vehicle at any given position and rotation

Syntax

bool spawnVehicle ( vehicle theVehicle, float x, float y, float z [, float rx, float ry, float rz ] )

OOP Syntax Help! I don't understand this!

Method: vehicle:spawn(...)


Required Arguments

  • theVehicle: The vehicle you wish to spawn
  • x: The x position you wish to spawn the vehicle at
  • y: The x position you wish to spawn the vehicle at
  • z: The x position you wish to spawn the vehicle at

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • rx: The x rotation you wish to spawn the vehicle at
  • ry: The y rotation you wish to spawn the vehicle at
  • rz: The z rotation you wish to spawn the vehicle at

Returns

Returns true if the vehicle spawned successfully, false if the passed argument does not exist or is not a vehicle.

Example

Click to collapse [-]
Server

With this feature, we spawn vehicle 

function myCommandHandler(thePlayer, command)
	local x, y, z = getElementPosition(thePlayer)
	local RaceVehicle = createVehicle ( 411, 0, 0, 0 ) 
	local spawnVeh = spawnVehicle ( RaceVehicle, x+3, y+3, z )	
	if spawnVeh	then	outputChatBox("Vehicle was spawned", thePlayer)	else	outputChatBox("Error",thePlayer)	end
end

addCommandHandler("spawnvehicle", myCommandHandler)

Related scripting functions


Retrieved from "https://wiki.multitheftauto.com/wiki/SpawnVehicle?oldid=80456"