Multi Theft Auto: Wiki - User contributions [en]

OnColShapeHit

2018-09-30T17:55:53Z

Moono:

__NOTOC__
{{Server event}}
{{Note|The hit won't be detected if the [[element]] that entered the colshape is a colshape.}}
This event is triggered when a physical [[element]] hits a [[colshape]].

==Parameters==
<syntaxhighlight lang="lua">
element hitElement, bool matchingDimension
</syntaxhighlight>

*'''hitElement''': the [[element]] that entered the colshape.
*'''matchingDimension''': a [[boolean]] referring to whether the hit collision shape was in the same [[dimension]] as the element.

==Source==
The [[event system#Event source|source]] of this event is the [[colshape]] that got hit by a player or vehicle.

==Example==
This example creates a hill area for a ''King of the hill'' gamemode. When a player enters or leaves the area, it's announced in the chatbox.
<syntaxhighlight lang="lua">
-- create our hill area for our gamemode
local hillArea = createColRectangle ( -2171.0678710938, 678.17950439453, 15, 15 )

-- add hill_Enter as a handler for when a player enters the hill area
function hill_Enter ( thePlayer, matchingDimension )
if getElementType ( thePlayer ) == "player" then --if the element that entered was player
--let's get the name of the player
local nameOfThePlayer = getPlayerName ( thePlayer )
--announce to everyone that the player entered the hill
outputChatBox ( nameOfThePlayer.." entered the zone!", getRootElement(), 255, 255, 109 )
end
end
addEventHandler ( "onColShapeHit", hillArea, hill_Enter )

-- add hill_Enter as a handler for when a player leaves the hill area
function hill_Exit ( thePlayer, matchingDimension )
if getElementType ( thePlayer ) == "player" then --if the element that left was player
--check if the player is not dead
if isPlayerDead ( thePlayer ) ~= true then
--let's get the name of the player
local nameOfThePlayer = getPlayerName ( thePlayer )
--if he was alive, announce to everyone that the player has left the hill
outputChatBox ( nameOfThePlayer.." left the zone!", getRootElement(), 255, 255, 109 )
end
end
end
addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )
</syntaxhighlight>

{{See also/Server event|Colshape events}}

GetPlayerAnnounceValue

2018-09-20T09:19:06Z

Moono: invalid template

__NOTOC__
{{Server function}}
{{New feature/item|3.0104|1.0.4||This function retrieves a players ASE announce value under a certain key.}}

==Syntax==
<syntaxhighlight lang="lua">string getPlayerAnnounceValue ( element thePlayer, string key )</syntaxhighlight>
{{OOP||[[player]]:getAnnounceValue||setPlayerAnnounceValue}}
===Required Arguments===
*'''thePlayer:''' This is the [[Player]] whos value you want to retrieve.
*'''key:''' The name of the key.

===Returns===
This function returns a ''string'' containing the requested value if a valid key was specified or ''false'' otherwise.

==Example==
This example adds a command named "getscore" which outputs a players "score" value to his chatbox.
<syntaxhighlight lang="lua">function getScore ( playerSource, cmdName )
local scoreValue = getPlayerAnnounceValue ( playerSource, "score" )
if ( scoreValue ) then
outputChatBox ( "Your score: "..scoreValue, playerSource )
end
end

addCommandHandler ( "getscore", getScore )
</syntaxhighlight>

==See Also==
{{Player functions}}
[[Category:Changes_in_1.0]]

GetVehicleEngineState

2018-09-19T18:59:30Z

Moono: invalid template

__NOTOC__
{{Server client function}}
{{New feature/item|3|1.0||This function returns a vehicle's engine state (on or off).}}
==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleEngineState ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getEngineState|engineState|setVehicleEngineState}}
===Required Arguments===
*'''theVehicle''': the [[vehicle]] you wish to get the engine state of.

===Returns===
Returns '''true''' if the vehicle's engine is started, '''false''' otherwise.

==Example==
<section name="Serverside example" class="server" show="true">
This example will switch the vehicle engine state with the command "/switchengine".
<syntaxhighlight lang="lua">
function switchEngine ( playerSource )
local theVehicle = getPedOccupiedVehicle ( playerSource )

-- Check if the player is in any vehicle and if he is the driver
if theVehicle and getVehicleController ( theVehicle ) == playerSource then
local state = getVehicleEngineState ( theVehicle )
setVehicleEngineState ( theVehicle, not state )
end
end
addCommandHandler ( "switchengine", switchEngine )
</syntaxhighlight>
</section>

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

Template:Vehicle functions

2018-09-19T17:36:41Z

Moono: client only func

*[[addVehicleSirens]]
*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getModelHandling]]
*[[getOriginalHandling]]
*[[getTrainDirection]]
*[[getTrainPosition]]
*[[getTrainSpeed]]
{{New items|3.0160|1.6|
*[[getTrainTrack]]
|7485}}
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleController]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleHandling]]
*[[getVehicleHeadLightColor]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleModelFromName]]
*[[getVehicleName]]
*[[getVehicleNameFromModel]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
{{New items|3.0156|1.5.5|
*[[getVehicleRespawnPosition]]
*[[getVehicleRespawnRotation]]
|14053}}
*[[getVehicleSirenParams]]
*[[getVehicleSirens]]
*[[getVehicleSirensOn]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
{{Deprecated items|3.0156|1.5.6|
*[[getVehicleTurnVelocity]]
}}
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleUpgrades]]
*[[getVehicleVariant]]
*[[getVehicleWheelStates]]
*[[getVehiclesOfType]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleDamageProof]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleOnGround]]
*[[isVehicleTaxiLightOn]]
*[[removeVehicleSirens]]
*[[removeVehicleUpgrade]]
*[[resetVehicleExplosionTime]]
*[[resetVehicleIdleTime]]
*[[respawnVehicle]]
*[[setModelHandling]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainPosition]]
*[[setTrainSpeed]]
{{New items|3.0160|1.6|
*[[setTrainTrack]]
|7485}}
*[[setVehicleColor]]
*[[setVehicleDamageProof]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleHandling]]
*[[setVehicleHeadLightColor]]
*[[setVehicleIdleRespawnDelay]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehiclePlateText]]
*[[setVehicleRespawnDelay]]
*[[setVehicleRespawnPosition]]
{{New items|3.0156|1.5.5|
*[[setVehicleRespawnRotation]]
|14280}}
*[[setVehicleSirens]]
*[[setVehicleSirensOn]]
*[[setVehicleTaxiLightOn]]
*[[setVehicleTurretPosition]]
{{Deprecated items|3.0156|1.5.6|
*[[setVehicleTurnVelocity]]
}}
*[[setVehicleVariant]]
*[[setVehicleWheelStates]]
*[[spawnVehicle]]
*[[toggleVehicleRespawn]]

<noinclude>[[Category:Functions templates]]</noinclude>

ClearElementVisibleTo

2018-09-17T16:05:47Z

Moono:

__NOTOC__
{{Server function}}
This function clears any settings added by setElementVisibleTo and restores an element to its default visibility. This does not work with all entities - [[vehicle]]s, [[player]]s and [[object]]s are exempt. This is because these objects are required for accurate sync (they're physical objects). This function is particularily useful for changing the visibility of markers, radar blips and radar areas.

==Syntax==
<syntaxhighlight lang="lua">
bool clearElementVisibleTo ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:clearVisibility|||}}

===Required Arguments===
*'''theElement:''' The element in which you wish to restore to its default visibility

===Returns===
Returns ''true'' if the operation was successful, ''false'' otherwise.

==Example==
This example clears any visibility settings after a player dies, so everyone can see his blip for a short period
<syntaxhighlight lang="lua">
-- specify the getBlipAttachedTo function
function getBlipAttachedTo( thePlayer )
local blips = getElementsByType( "blip" )
for k, theBlip in ipairs( blips ) do
if getElementAttachedTo( theBlip ) == thePlayer then
return theBlip
end
end
return false
end

function clearVisibilityWasted ( totalammo, killer, killerweapon, bodypart ) -- when a player dies
clearElementVisibleTo ( getBlipAttachedTo ( source ) ) -- clear any visiblity settings of his blip
end
addEventHandler ( "onPlayerWasted", getRootElement(), clearVisibilityWasted ) --add an event handler for onPlayerWasted
</syntaxhighlight>

==See Also==
{{Element_functions}}

Template:Client weapon functions

2018-09-17T04:13:16Z

Moono: already present in ped. there is place for this function.

*[[getOriginalWeaponProperty]]
*[[getSlotFromWeapon]]
*[[getWeaponIDFromName]]
*[[getWeaponNameFromID]]
*[[getWeaponProperty]]

<noinclude>[[Category:Functions templates]]</noinclude>

MoveObject

2018-09-16T19:03:43Z

Moono: Undo revision 59178 by Moono (talk)

__NOTOC__
{{Server client function}}
This function will smoothly move an object from its current position to a specified rotation and position.

==Syntax==
<syntaxhighlight lang="lua">
bool moveObject ( object theObject, int time, float targetx, float targety, float targetz, [ float moverx, float movery, float moverz, string strEasingType, float fEasingPeriod, float fEasingAmplitude, float fEasingOvershoot ] )
</syntaxhighlight>
{{OOP||[[object]]:move||}}
===Required Arguments===
* '''theObject:''' the object that will be moved.
* '''time:''' the time in milliseconds the object will arrive at the destination.
* '''targetx:''' the X value of the target position
* '''targety:''' the Y value of the target position
* '''targetz:''' the Z value of the target position

===Optional Arguments===
* '''moverx:''' the rotation along the X axis '''relative''' to its current rotation, which is its starting angle.
* '''movery:''' the rotation along the Y axis '''relative''' to its current rotation, which is its starting angle.
* '''moverz:''' the rotation along the Z axis '''relative''' to its current rotation, which is its starting angle.
*'''strEasingType:''' the [[Easing|easing function]] to use for the interpolation (default is "Linear")
*'''fEasingPeriod:''' the period of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingAmplitude:''' the amplitude of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingOvershoot:''' the overshoot of the [[Easing|easing function]] (only some easing functions use this parameter)

===Returns===
* ''true'' if the function moved the object succesfully.
* ''false'' otherwise.

==Examples ==
<section name="Server" class="server" show="true">
'''Example 1:''' This example moves every object in the game up 100 units in ten seconds.
<syntaxhighlight lang="lua">
allObjects = getElementsByType ( "object" )
for key, theObject in ipairs ( allObjects ) do
local origX, origY, origZ = getElementPosition ( theObject ) --get the origanal position
local newZ = origZ + 100 -- make a new z position
moveObject ( theObject, 10000, origX, origY, newZ ) --move the object to this position in 10 seconds.
end
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
'''Example 2:''' This example created a model (of a bed) near a player called ''someguy'', if they exist in the game. It will then move the model towards the player over 3 seconds.
<syntaxhighlight lang="lua">
-- Find a player called 'someguy'
someGuy = getPlayerFromName ( "someguy" )
-- If a player called someguy was found then
if ( someGuy ) then
-- Get the player's position
x, y, z = getElementPosition ( someGuy )
-- Create a bed (1700) object near to the player
bed = createObject ( 1700, x + 5, y, z )
-- Move the bed towards the player over 3 seconds (3000 milliseconds)
moveObject ( bed, 3000, x, y, z )
-- Tell the player in the chat box
outputChatBox ( "Moving a bed towards you!", someGuy )
else
-- Tell everyone that a player called 'someguy' could not be found
outputChatBox ( "Player someguy doesn't exist" )
end
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
'''Example 3:''' This example creates a ball moving (in front of CJ's house in Grove Street) using easing functions. Test command is "/smove" for instance "/smove OutBounce". This example is a serverside code but the same could be done clientside (adapting the command handler)
<syntaxhighlight lang="lua">
local START_POS = {2497.203125, -1672.4864501953, 12.640947341919}
local STOP_POS = {2480.2595214844, -1666.521484375, 12.640114784241}
local MOTION_DURATION = 5000
local WAIT_DURATION = 1000

addCommandHandler("smove",
function (player, cmd, strEasingType, period, amplitude, overshoot)
local x, y, z = unpack(START_POS)
local object = createObject(1598, x, y, z)
x, y, z = unpack(STOP_POS)

period = period or 0.3
amplitude = amplitude or 1.0
overshoot = overshoot or 1.70158

outputChatBox(string.format("Server Easing %s %s %s %s", strEasingType, tostring(period), tostring(amplitude), tostring(overshoot)))
moveObject(object, MOTION_DURATION, x, y, z, 0, 0, 360, strEasingType, period, amplitude, overshoot)
setTimer(destroyElement, MOTION_DURATION+WAIT_DURATION, 1, object)
end)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
'''Example 4:''' This example move a gate with easing.
<syntaxhighlight lang="lua">
local x,y,z = 2096.3, 1721, 12.7
local easing = "OutBounce"
local time = 2000
local gate = createObject(980, x,y,z, 0, 0, 63)
local marker = createMarker(x,y,z, "cylinder", 12, 0, 0, 0, 0)

function moveGate(hitPlayer, matchingDimension)
moveObject(gate, time, x+4.9, y+9.6, z, 0, 0, 0, easing)
end
addEventHandler("onMarkerHit", marker, moveGate)

function moveBack()
moveObject(gate, time, x, y, z, 0, 0, 0, easing)
end
addEventHandler("onMarkerLeave", marker, moveBack)
</syntaxhighlight>
</section>

== Issues ==
{{Issues|
{{Issue|8576|Object rotation is wrong after moveObject serverside}}
}}
==See Also==
{{Object functions}}

MoveObject

2018-09-16T19:01:27Z

Moono: by standart

__NOTOC__
{{Server client function}}
This function will smoothly move an object from its current position to a specified rotation and position.

==Syntax==
<syntaxhighlight lang="lua">
bool moveObject ( object theObject, int time, float targetx, float targety, float targetz, [ float moverx, float movery, float moverz, string strEasingType, float fEasingPeriod, float fEasingAmplitude, float fEasingOvershoot ] )
</syntaxhighlight>
{{OOP||[[object]]:move||}}
===Required Arguments===
* '''theObject:''' the object that will be moved.
* '''time:''' the time in milliseconds the object will arrive at the destination.
* '''targetx:''' the X value of the target position
* '''targety:''' the Y value of the target position
* '''targetz:''' the Z value of the target position

===Optional Arguments===
* '''moverx:''' the rotation along the X axis '''relative''' to its current rotation, which is its starting angle.
* '''movery:''' the rotation along the Y axis '''relative''' to its current rotation, which is its starting angle.
* '''moverz:''' the rotation along the Z axis '''relative''' to its current rotation, which is its starting angle.
*'''strEasingType:''' the [[Easing|easing function]] to use for the interpolation (default is "Linear")
*'''fEasingPeriod:''' the period of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingAmplitude:''' the amplitude of the [[Easing|easing function]] (only some easing functions use this parameter)
*'''fEasingOvershoot:''' the overshoot of the [[Easing|easing function]] (only some easing functions use this parameter)

===Returns===
* ''true'' if the function moved the object succesfully.
* ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example moves every object in the game up 100 units in ten seconds.
<syntaxhighlight lang="lua">
allObjects = getElementsByType ( "object" )
for key, theObject in ipairs ( allObjects ) do
local origX, origY, origZ = getElementPosition ( theObject ) --get the origanal position
local newZ = origZ + 100 -- make a new z position
moveObject ( theObject, 10000, origX, origY, newZ ) --move the object to this position in 10 seconds.
end
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
'''Example 2:''' This example created a model (of a bed) near a player called ''someguy'', if they exist in the game. It will then move the model towards the player over 3 seconds.
<syntaxhighlight lang="lua">
-- Find a player called 'someguy'
someGuy = getPlayerFromName ( "someguy" )
-- If a player called someguy was found then
if ( someGuy ) then
-- Get the player's position
x, y, z = getElementPosition ( someGuy )
-- Create a bed (1700) object near to the player
bed = createObject ( 1700, x + 5, y, z )
-- Move the bed towards the player over 3 seconds (3000 milliseconds)
moveObject ( bed, 3000, x, y, z )
-- Tell the player in the chat box
outputChatBox ( "Moving a bed towards you!", someGuy )
else
-- Tell everyone that a player called 'someguy' could not be found
outputChatBox ( "Player someguy doesn't exist" )
end
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
'''Example 3:''' This example creates a ball moving (in front of CJ's house in Grove Street) using easing functions. Test command is "/smove" for instance "/smove OutBounce". This example is a serverside code but the same could be done clientside (adapting the command handler)
<syntaxhighlight lang="lua">
local START_POS = {2497.203125, -1672.4864501953, 12.640947341919}
local STOP_POS = {2480.2595214844, -1666.521484375, 12.640114784241}
local MOTION_DURATION = 5000
local WAIT_DURATION = 1000

addCommandHandler("smove",
function (player, cmd, strEasingType, period, amplitude, overshoot)
local x, y, z = unpack(START_POS)
local object = createObject(1598, x, y, z)
x, y, z = unpack(STOP_POS)

period = period or 0.3
amplitude = amplitude or 1.0
overshoot = overshoot or 1.70158

outputChatBox(string.format("Server Easing %s %s %s %s", strEasingType, tostring(period), tostring(amplitude), tostring(overshoot)))
moveObject(object, MOTION_DURATION, x, y, z, 0, 0, 360, strEasingType, period, amplitude, overshoot)
setTimer(destroyElement, MOTION_DURATION+WAIT_DURATION, 1, object)
end)
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
'''Example 4:''' This example move a gate with easing.
<syntaxhighlight lang="lua">
local x,y,z = 2096.3, 1721, 12.7
local easing = "OutBounce"
local time = 2000
local gate = createObject(980, x,y,z, 0, 0, 63)
local marker = createMarker(x,y,z, "cylinder", 12, 0, 0, 0, 0)

function moveGate(hitPlayer, matchingDimension)
moveObject(gate, time, x+4.9, y+9.6, z, 0, 0, 0, easing)
end
addEventHandler("onMarkerHit", marker, moveGate)

function moveBack()
moveObject(gate, time, x, y, z, 0, 0, 0, easing)
end
addEventHandler("onMarkerLeave", marker, moveBack)
</syntaxhighlight>
</section>

== Issues ==
{{Issues|
{{Issue|8576|Object rotation is wrong after moveObject serverside}}
}}
==See Also==
{{Object functions}}