Multi Theft Auto: Wiki - User contributions [en]

GetObjectModel

2008-11-22T11:10:28Z

Crazy: GetObjectModel is also working clientside

__NOTOC__
{{Server client function}}
This function retrieves the model ID of a specified object

==Syntax==
<syntaxhighlight lang="lua">
int getObjectModel ( object theObject )
</syntaxhighlight>

===Required Arguments===
*'''theObject:''' The object which you wish to retrieve the model ID of

===Returns===
Returns an ''int'' with the object model id, or ''false'' it's no or an invalid object.

==Example==
This example destroys a haystack when a player targets it.
<syntaxhighlight lang="lua">
function onPlayerTargeted ( targetElem )
if ( getElementType ( targetElem ) == "object" ) and ( getObjectModel ( targetElem ) == 3374 ) then
destroyElement ( targetElem )
end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTargeted )
</syntaxhighlight>

This example outputs the model id of objects the player is targeting.
<syntaxhighlight lang="lua">
function onPlayerTargeted ( targetElem )
if ( getElementType ( targetElem ) == "object") then
outputChatBox ( getObjectModel(targetElem) )
end
end
addEventHandler ( "onPlayerTarget", getRootElement(), onPlayerTargeted )
</syntaxhighlight>

==See Also==
{{Object functions}}

GetPlayerAmmoInClip

2008-04-19T16:24:02Z

Crazy: /* Syntax */

{{Server client function}}
__NOTOC__
This function returns an integer that contains the ammo in a specified [[player]]'s weapon. See [[weapon|Weapon Info]]

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
int getPlayerAmmoInClip ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] whose ammo you want to check.

===Returns===
Returns an [[int]] containing the amount of ammo in the player's currently selected clip, or 0 if the player specified is invalid.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getPlayerAmmoInClip ( player thePlayer , int weaponSlot )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The [[player]] whose ammo you want to check.
*'''weaponSlot:''' an integer representing the weapon slot.

===Optional Arguments===
none

===Returns===
Returns an [[int]] containing the amount of ammo in the specified player's currently selected or specified clip, or 0 if the player specified is invalid.
</section>

==Example==
<section name="Server" class="server" show="true">
This example outputs the amount of ammo the specified player has in his current slot. For example: 'ammo someguy'.
<syntaxhighlight lang="lua">
function showAmmo( thePlayer, command, who )
local targetPlayer = getPlayerFromNick ( who )
if ( thePlayer ) then
local ammo = getPlayerAmmoInClip ( targetPlayer )
outputChatBox ( who .. " has " .. ammo .. " ammo in his active clip", thePlayer )
else
outputChatBox ( "Player '" .. who .. "' not found.", thePlayer )
end
end
addCommandHandler( "ammo", showAmmo )
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

GetPlayerWeaponSlot

2008-04-19T16:22:23Z

Crazy: /* Syntax */

__NOTOC__
{{Needs_Checking|Firstly, this doesnt even work properly apparently, and secondly, is there ANY point to this function? We have getPlayerWeapon and getWeaponFromSlot. This doesnt seem to have any necessity. As a buggy function, it should be removed}}
This function gets the player's weapon slot.

==Syntax==
<syntaxhighlight lang="lua">
int getPlayerWeaponSlot ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': the [[player]] you want to get the weapon slot from.

===Optional Arguments===
none

===Returns===
Returns the weapon slot (as ''number'') on success, returns ''false'' otherwise.
{{Weapon_Slots}}

==Example==
<syntaxhighlight lang="lua">
Pending.
</syntaxhighlight>

==See Also==
* [[SetPlayerWeaponSlot]]

GetVehicleLightState

2008-04-06T10:37:24Z

Crazy:

{{Needs Checking|Seems that the function is broken and returns always 255 instead of 0 or 1. --[[User:Crazy|Crazy]] 05:37, 6 April 2008 (CDT) }}
{{Server client function}}
__NOTOC__
This function returns the current state of the specified light on the vehicle.

==Syntax==
<syntaxhighlight lang="lua">getVehicleLightState ( vehicle theVehicle, int light )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' A handle to the [[vehicle]] that you wish to know the light state of.
*'''light:''' A whole number between 0 and 3

==Returns==
Returns 0 (working) or 1 (broken)

==Example==
<syntaxhighlight lang="lua">newcar = createVehicle ( 520, 1024, 1024, 1024 )
state = getVehicleLightState ( newcar, 0 )
outputChatBox ( "The front-left light state on this car: " .. state )</syntaxhighlight>

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