Multi Theft Auto: Wiki - User contributions [en]

SetElementVisibleTo

2013-08-26T07:42:42Z

Funstein:

__NOTOC__
This function can change an [[element]]'s [[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 particularly useful for changing the visibility of markers, radar blips and radar areas.

Visibility settings of lower elements in the element tree override higher ones - if visibility for root is set to false and for a player is set to true, it will be visible to the player.

If you want to clear all visibility settings of an object, try [[clearElementVisibleTo]]

==Syntax==
<syntaxhighlight lang="lua">
bool setElementVisibleTo ( element theElement, element visibleTo, bool visible )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element you want to control the visibility of.
*'''visibleTo:''' The element you wish the element to be visible or invisible to. Any child elements that are players will also be able to see the element. See [[visibility]].
*'''visible:''' Whether you are making it visible or invisible to the player.

===Returns===
Returns ''true'' if the element's visibility was changed successfully, ''false'' otherwise, for example if you are trying to change the visibility of a vehicle, player or object.

==Example==
This example creates a marker and makes it only visibile to the player called 'someguy'.
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
-- Set marker visibility to true for someguy
setElementVisibleTo ( myMarker, someguy, true )
-- Then make the marker invisible to the whole dimension
setElementVisibleTo ( myMarker, root, false )

-- The order in which you do the visibility changes does not matter, but ideally trues should be set before falses in order to prevent a momentary flicker.
end
</syntaxhighlight>

The following example shows how to make the marker visible to everyone except anotherguy
<syntaxhighlight lang="lua">
-- Find the player called someguy
local someguy = getPlayerFromName ( "someguy" )
local anotherguy = getPlayerFromName ( "anotherguy" )
-- If the player was found then
if ( someguy ) then
-- Get the player's position into the variables x, y and z
x, y, z = getElementPosition ( someguy )
-- Create a marker at the player's position
myMarker = createMarker ( x, y, z )
attachElements(myMarker, someguy)

-- First make sure everyone is able to see the marker, this line is unnecessary in this case as root visibility is set to true by default behaviour
setElementVisibleTo ( myMarker, root, true )

-- Then hide it from anotherguy
setElementVisibleTo ( myMarker, anotherguy, false )
end
</syntaxhighlight>

==See Also==
{{Element_functions}}

GetVehicleOccupants

2013-08-06T20:23:00Z

Funstein: Made example prettier

{{Server client function}}
__NOTOC__
This function gets all players sitting in the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleOccupants ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle of which you wish to retrieve the occupants.

===Returns===
Returns a [[table]] with contents...

table[seat] = occupant

... if successful. Returns ''false'' in the case of failure.

'''Note:''' Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.

==Example==
This example prints all vehicle occupants into the F8 console if "/occupants" is typed:
<syntaxhighlight lang="lua">
function outputOccupants(player)
if isPedInVehicle(player) then -- If he is actually in a vehicle...
outputConsole("------------------------------------", player) -- Print a seprerator for easier reading
for seat, occupant in pairs(getVehicleOccupants(getPedOccupiedVehicle(player))) do -- Loop through the array
if getElementType(occupant) == "player" then
outputConsole("Seat " .. seat .. ": " .. getPlayerName(occupant), player) -- Print who's in the seat
end
end
outputConsole("------------------------------------",player) -- Print another seprerator
end
end
addCommandHandler("occupants",outputOccupants) -- Add a command "/occupants" which triggers outputOccupants
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}

GetElementZoneName

2013-02-16T11:56:02Z

Funstein:

{{Server function}}
__NOTOC__
This function allows you to retrieve the zone name of an element (eg. Verdant Bluffs or Ocean Docks)

The same can be achieved client side by getting element coordinates and using [[GetZoneName]].

==Syntax==
<syntaxhighlight lang="lua">
string getElementZoneName ( element theElement, [bool citiesonly=false] )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The element which you'd like to retrieve the zone name from

===Optional Arguments===
{{OptionalArg}}
*'''citiesonly''': An optional argument to choose if you want to return the city name (eg Las Venturas)

===Returns===
Returns the string of the elements zone name.

==Example==
This example shows you how to return your own location by doing /loc in the chatbox or just loc in console
<syntaxhighlight lang="lua">
function playerloc ( source )
local playername = getPlayerName ( source )
local location = getElementZoneName ( source )
outputChatBox ( "* " .. playername .. "'s Location: " .. location, getRootElement(), 0, 255, 255 ) -- Output the player's name and zone name
end
addCommandHandler ( "loc", playerloc )
</syntaxhighlight>

==See Also==
{{Element functions}}

Template:Useful Functions

2013-01-08T16:48:54Z

Funstein:

*[[callClientFunction]] » This function allows you to call any clientside function from the server's side.
*[[callServerFunction]] » This function allows you to call any server-side function from the client's side.
*[[centerWindow]] » This function center the window in any resolution.
*[[Check]] » This function checks if it's arguments are of the right types and calls the error-function if one isn't.
*[[coroutine.resume]] » Fix for hidden coroutine error messages
*[[dxDrawColorText]] » This function draws a dx text with #RRGGBB color codes support.
*[[dxDrawGifImage]] » This function simulates the effect of a GIF image by using image sprites.
*[[dxDrawImage3D]] » This function draws a 3D image.
*[[dxDrawRectangle3D]] » This function draws a 3D rectangle.
*[[dxGetFontSizeFromHeight]] » This function calculate a font size from given height for dxDraw.
*[[dxGetRealFontHeight]] » Accurately measures the pixel height of a font.
*[[findRotation]] » Takes two points and returns the direction from point A to point B.
*[[FormatDate]] » Formats a date on the basis of a format string and returns it.
*[[GenerateString]] » With this function you can generate a random string with any characters.
*[[getAge]] » This function calculates the age of a birthday.
*[[getAlivePlayers (Client)|getAlivePlayers]] » This function returns all the alive players by a client side, so you can store them into a Gridlist or something like that, faster.
*[[getAlivePlayersInTeam]] » This function returns a table of the alive players in a team.
*[[getCursorMoveOn]] » This function checks in which way the cursor is currently moving.
*[[getDistanceBetweenPointAndSegment2D]] » Takes point coordinates and line (a segment) starting and ending coordinates. It returns the shortest distance between the point and the line.
*[[getElementSpeed]] » This function allows you to get element speed in kph or mph units.
*[[getJetpackWeaponsEnabled]] » This function returns a table of enabled weapons usable on a jetpack.
*[[getOffsetFromXYZ]] » This function allows you to take an entity and a position and calculate the relative offset between them accounting for rotations.
*[[getOnlineAdmins]] » This function will give the online admins.
*[[getOnlineStaff]] » Returns all online staff, names separated by two spaces.
*[[getPlayerFromNamePart]] » This function allows you to get player From his Name part.
*[[getPlayersInPhotograph]] » This function gets all the players in a photograph.
*[[getPointFromDistanceRotation]] » Finds a point based on a starting point, direction and distance.
*[[getResourceSettings]] » This function returns a table of the resource settings.
*[[getTimestamp]] » With this function you can get the UNIX timestamp.
*[[getXMLNodes]] » Returns all children of a node
*[[guiComboBoxAdjustHeight]] » Adjusts the combobox to have a correct height.
*[[guiEditSetActive]] » Puts the caret of an editbox to the gived position.
*[[IfElse]] » Returns one of two values based on a boolean expression.
*[[isElementInPhotograph]] » This function checks if an element was in the player's camera picture.
*[[isElementInRange]] » This function allows you to check is the element's range to the main point is smaller than (or as big as) the maximum range.
*[[IsElementMoving]]» This function checks if an element is moving.
*[[isPedAiming]]» This function checks if a ped is aiming.
*[[isPlayerInTeam]] » This function check if the player in the team.
*[[isLeapYear]] » Checks if the given year is a leap year.
*[[isVehicleOnRoof]] » This function checks whether vehicle is on roof.
*[[iterElements]] » Returns an iterator for your for loops saving time typing ipairs( getElementsByType( type ) ), instead you type: iterElements( type ).
*[[math.round]] » Rounds a number whereas the number of decimals to keep and the method may be set.
*[[multi_check]] » This function checks one element to many, handy and clean.
*[[onVehicleWeaponFire]] » This code implements an event that is triggered when a player in a vehicle fires a vehicles weapon.
*[[setElementSpeed]] » This function allows you to set moving element speed in kph or mph units.
*[[setTableProtected]] » Protects a table and makes it read-only.
*[[setVehicleGravityPoint]] » This clientside function sets a vehicle's gravity in the direction of a 3 dimensional coordinate with the strength specified.
*[[string.count]] » This function counts a text from a text.
*[[string.explode]] » This function splits a string at a given separator pattern and returns a table with the pieces.
*[[switch]] » This function allow the value of a variable or expression to control the flow of program execution via a multiway branch.
*[[table.copy]] » This function copies a whole table and all the tables in that table.
*[[table.condition]] » This function check if both tables is equal. 
*[[table.empty]] » This function check is empty table or not.
*[[table.map]] » This function goes through a table and replaces every field with the return of the passed function, where the field's value is passed as first argument and optionally more arguments.
*[[table.random]] » This function retrieves a random variable from a table.
*[[table.size]] » Finds the absolute size of a table.
*[[var dump]] » This function outputs information about one or more variables using outputConsole()
*[[RGBToHex]] » This function returns a string representing the color in hexadecimal.
*[[toHex]] » This function converts a decimal number to a hexadecimal number, as a fix to be used clientside.
*[[wavelengthToRGBA]] » This function converts a phisical wavelength of light to a RGBA color.
*[[convertNumber]] » This function converts large numbers and adds commas to it. (Example: 100000 -> 100,000)
[[Category:Useful Functions]]

IsPedAiming

2013-01-08T16:46:45Z

Funstein:

{{Useful Function}}
__NOTOC__
This function checks if a ped is aiming. Returns true if yes and false if not.
 
'''Important : ONLY WORKS CLIENT SIDE.'''
 

==Syntax==
<syntaxhighlight lang="lua">bool isPedAiming ( ped thePedToCheck )</syntaxhighlight>

===Required Arguments===
* '''thePedToCheck''': The ped element.

===Returns===
Returns true if ped is aiming a weapon, false if not.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function isPedAiming ( thePedToCheck )
if isElement(thePedToCheck) then
if getElementType(thePedToCheck) == "player" or getElementType(thePedToCheck) == "ped" then
if getPedTask(thePedToCheck, "secondary", 0) == "TASK_SIMPLE_USE_GUN" then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
The example outputs if the player is aiming a gun when the player presses b.
<syntaxhighlight lang="lua">
function checkAim()
if isPedAiming(localPlayer) then
outputChatBox("Aiming")
else
outputChatBox("Not aiming")
end
end
bindKey("b", "down", checkAim)
</syntaxhighlight>

==See Also==
{{Useful_Functions}}

IsPedAiming

2013-01-08T16:39:11Z

Funstein: Created page with "{{Useful Function}} __NOTOC__ This function checks if a ped is aiming. Returns true if yes and false if not. '''ONLY WORKS CLIENT SIDE''' ==Syntax== <syntaxhighlight lang="lua">bool ..."

{{Useful Function}}
__NOTOC__
This function checks if a ped is aiming. Returns true if yes and false if not.
 
'''ONLY WORKS CLIENT SIDE'''
 

==Syntax==
<syntaxhighlight lang="lua">bool isPedAiming ( ped thePedToCheck )</syntaxhighlight>

===Required Arguments===
* '''thePedToCheck''': The ped element.

===Returns===
Returns true if ped is aiming a weapon, false if not.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function isPedAiming ( thePedToCheck )
if isElement(thePedToCheck) then
if getElementType(thePedToCheck) == "player" or getElementType(thePedToCheck) == "ped" then
if getPedTask(thePedToCheck, "secondary", 0) == "TASK_SIMPLE_USE_GUN" then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

==Example==
No example >:(

==See Also==
{{Useful_Functions}}

Template:Client input functions

2013-01-07T19:01:20Z

Funstein:

*[[bindKey]]
*[[unbindKey]]
*[[getKeyState]]
{{New items|3.0004|1.0.4|
*[[getCommandsBoundToKey]]
*[[getFunctionsBoundToKey]]
*[[getKeyBoundToCommand]]
*[[getKeyBoundToFunction]]
}}
*[[getControlState]]
*[[isControlEnabled]]
*[[setControlState]]
*[[toggleControl]]
*[[toggleAllControls]]
*[[getCursorPosition]]
*[[addCommandHandler]]
*[[removeCommandHandler]]
*[[executeCommandHandler]]
*[[getBoundKeys]]
*[[getAnalogControlState]]
<noinclude>[[Category:Functions templates]]</noinclude>

GetCursorPosition

2013-01-07T19:01:00Z

Funstein:

{{Client function}}
__NOTOC__
This function gets the current position of the mouse cursor. Note that for performance reasons, the world position returned is always 300 units away. If you want the exact world point (similar to [[onClientClick]]), use [[processLineOfSight]] between the camera position and the worldX/Y/Z result of this function. (See example below)

==Syntax==
<syntaxhighlight lang="lua">
float float float float float getCursorPosition ( )
</syntaxhighlight>

===Returns===
Returns 5 values: ''cursorX'', ''cursorY'', ''worldX'', ''worldY'', ''worldZ''. The first two values are the 2D relative screen coordinates of the cursor: ''cursorX'' goes from 0 (left side of the screen) to 1 (right side), ''cursorY'' goes from 0 (top) to 1 (bottom). The 3 values that follow are the 3D world map coordinates that the cursor points at. If the cursor isn't showing, returns ''false'' as the first value.

==Example==
This example prints your cursors current world coordinates and relative screen coordinates to chatbox after typing ''cursorpos''.
<syntaxhighlight lang="lua">
function cursorInfo()
local showing = isCursorShowing ()
if showing then -- if the cursor is showing
local screenx, screeny, worldx, worldy, worldz = getCursorPosition()

outputChatBox( string.format( "Cursor screen position (relative): X=%.4f Y=%.4f", screenx, screeny ) ) -- make the accuracy of floats 4 decimals
outputChatBox( string.format( "Cursor world position: X=%.4f Y=%.4f Z=%.4f", worldx, worldy, worldz ) ) -- make the accuracy of floats 4 decimals accurate
else
outputChatBox( "Your cursor is not showing." )
end
end
addCommandHandler( "cursorpos", cursorInfo )
</syntaxhighlight>

This (untested) example uses [[processLineOfSight]] to calculate the exact world location:
<syntaxhighlight lang="lua">
addEventHandler( "onClientRender", root,
function()
if isCursorShowing() then
local screenx, screeny, worldx, worldy, worldz = getCursorPosition()
local px, py, pz = getCameraMatrix()
local hit, x, y, z, elementHit = processLineOfSight ( px, py, pz, worldx, worldy, worldz )

if hit then
dxDrawText( "Cursor at " .. x .. " " .. y .. " " .. z, 200, 200 )
if elementHit then
dxDrawText( "Hit element " .. getElementType(elementHit), 200, 220 )
end
end
end
end
)
</syntaxhighlight>
==See Also==
{{Client_cursor_functions}}

Template:Client cursor functions

2013-01-07T19:00:11Z

Funstein:

*[[getCursorPosition]]
*[[setCursorPosition]]
*[[isCursorShowing]]
*[[showCursor]]

GetVehicleOccupants

2012-12-30T13:40:11Z

Funstein:

{{Server client function}}
__NOTOC__
This function gets all players sitting in the specified vehicle.

==Syntax==
<syntaxhighlight lang="lua">
table getVehicleOccupants ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle of which you wish to retrieve the occupants.

===Returns===
Returns a [[table]] with contents...

table[seat] = occupant

... if successful. Returns ''false'' in the case of failure.

'''Note:''' Don't use an ipairs loop with the table returned by this function. It will skip the driver, as ipairs starts at 1 and the driver seat is ID 0. And if there's an empty seat, ipairs will stop looping. You should use a pairs loop instead.

==Example==
This example prints all vehicle occupants into the F8 console if "/occupants" is typed:
<syntaxhighlight lang="lua">function outputOccupants(player)
if isPedInVehicle(player) then -- If he is actually in a vehicle...
local veh = getPedOccupiedVehicle(player) -- Get the vehicle the player is in
local occupants = getVehicleOccupants(veh) -- Get all vehicle occupants

outputConsole("------------------------------------",player) -- Print a seprerator for easier reading

for seat, occupant in pairs(occupants) do -- Loop through the array
if getElementType(occupant)=="player" then -- If the seat is occupied by a player...
occupant = getPlayerName(occupant) -- ... get his/her name
elseif getElementType(occupant)=="ped" then -- If the seat is occupied by a ped...
occupant = "<ped>" -- ... clear up there's a ped in the seat
end

outputConsole("Seat "..seat..": "..occupant,player) -- Print who's in the seat
end

outputConsole("------------------------------------",player) -- Print another seprerator
end
end
addCommandHandler("occupants",outputOccupants) -- Add a command "/occupants" which triggers outputOccupants
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}