SpawnVehicle: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
(21 intermediate revisions by 12 users not shown) | |||
Line 1: | Line 1: | ||
{{Server function}} | {{Server function}} | ||
__NOTOC__ | __NOTOC__ | ||
Spawns a vehicle at any given position and rotation | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool | bool spawnVehicle ( vehicle theVehicle, float x, float y, float z [, float rx, float ry, float rz ] ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[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=== | ||
*''' | {{OptionalArg}} | ||
*'''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=== | ||
Returns ''true'' if the vehicle | Returns ''true'' if the vehicle spawned successfully, ''false'' if the passed argument does not exist or is not a vehicle. | ||
==Example== | |||
<section name="Server" class="server" show="true"> | |||
With this feature, we spawn vehicle | |||
<syntaxhighlight lang="lua">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) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | |||
== | ==Related scripting functions== | ||
{{Vehicle_functions|server}} | |||
{{ | |||
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 [-]
ServerWith 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
- addVehicleSirens
- getModelHandling
- getVehicleIdleRespawnDelay
- getVehicleRespawnDelay
- getVehicleRespawnPosition
- getVehicleRespawnRotation
- getVehiclesOfType
- isVehicleRespawnable
- removeVehicleSirens
- resetVehicleExplosionTime
- resetVehicleIdleTime
- respawnVehicle
- setModelHandling
- setVehicleIdleRespawnDelay
- setVehicleRespawnDelay
- setVehicleRespawnPosition
- setVehicleRespawnRotation
- spawnVehicle
- toggleVehicleRespawn
- Shared
- addVehicleUpgrade
- attachTrailerToVehicle
- blowVehicle
- createVehicle
- detachTrailerFromVehicle
- fixVehicle
- getOriginalHandling
- getTrainDirection
- getTrainPosition
- getTrainSpeed
- getTrainTrack
- getVehicleColor
- getVehicleCompatibleUpgrades
- getVehicleController
- getVehicleDoorOpenRatio
- getVehicleDoorState
- getVehicleEngineState
- getVehicleHandling
- getVehicleHeadLightColor
- getVehicleLandingGearDown
- getVehicleLightState
- getVehicleMaxPassengers
- getVehicleModelFromName
- getVehicleName
- getVehicleNameFromModel
- getVehicleOccupant
- getVehicleOccupants
- getVehicleOverrideLights
- getVehiclePaintjob
- getVehiclePanelState
- getVehiclePlateText
- getVehicleSirenParams
- getVehicleSirens
- getVehicleSirensOn
- getVehicleTowedByVehicle
- getVehicleTowingVehicle
- getVehicleTurretPosition
- getVehicleType
- getVehicleUpgradeOnSlot
- getVehicleUpgradeSlotName
- getVehicleUpgrades
- getVehicleVariant
- getVehicleWheelStates
- isTrainDerailable
- isTrainDerailed
- isVehicleBlown
- isVehicleDamageProof
- isVehicleFuelTankExplodable
- isVehicleLocked
- isVehicleOnGround
- isVehicleTaxiLightOn
- removeVehicleUpgrade
- setTrainDerailable
- setTrainDerailed
- setTrainDirection
- setTrainPosition
- setTrainSpeed
- setTrainTrack
- setVehicleColor
- setVehicleDamageProof
- setVehicleDoorOpenRatio
- setVehicleDoorState
- setVehicleDoorsUndamageable
- setVehicleEngineState
- setVehicleFuelTankExplodable
- setVehicleHandling
- setVehicleHeadLightColor
- setVehicleLandingGearDown
- setVehicleLightState
- setVehicleLocked
- setVehicleOverrideLights
- setVehiclePaintjob
- setVehiclePanelState
- setVehiclePlateText
- setVehicleSirens
- setVehicleSirensOn
- setVehicleTaxiLightOn
- setVehicleTurretPosition
- setVehicleVariant
- setVehicleWheelStates