Multi Theft Auto: Wiki - User contributions [en]

Id

2007-11-18T03:40:08Z

TalidanOld:

'''Note: this page needs to link functions they apply to'''

ID stands for identification. It is a whole-number integer that refers to many mechanics of San Andreas.
----
Game elements using IDs:
''Note: does not include small ID lists related to specific functions or IDs created by MTA''
*[[Character Skins]]
*Clothing Styles
*[[Template:Projectiles|Projectiles]]
*[[Template:Blip_Icons|Radar Blips]]
*[[Template:Sounds|Sounds]]
*[[Vehicle_IDs]]
* [[Template:Vehicle_colors|Vehicle Colors]]
*Vehicle Upgrades
*[[Weapons|Weapons]]
*[http://vces.net/info/WeatherIDs.html Weather] '''brophy needs to use 1-19 only''' ''Note: blended weather allows for many more undocumented effects''

==See Also==
{{IDs}}

'''Credit for information contained in the pages:'''
Ransom (initial creation, formatting, and all lists not credited to others) eAi (vehicle colors list) erorr404/Talidan/Brophy (sound list) Talidan (radar blip pictures/vehicle list) Hellfish (skin pictures [http://www.gtaforums.com/index.php?showtopic=205220 SOURCE]) Brophy/Ratt/Panther/Twig (lots of inital ID data) GTAForums (Allowing Ransom to find IDs for lists)

CreateColCircle

2007-11-18T03:31:37Z

TalidanOld:

{{Needs_Checking|According to definition, z does not need defining. Rewrite the syntax?}}

__NOTOC__
{{Server client function}}
This function creates a collision circle. This is a shape that has a position and a radius and infinite height that you can use to detect a player's presence. Events will be triggered when a player enters or leaves it.

==Syntax==
<syntaxhighlight lang="lua">
colshape createColCircle ( float fX, float fY, float fZ, float radius )
</syntaxhighlight>

===Required Arguments===
*'''fX:''' The collision circle's center point's X axis position
*'''fY:''' The collision circle's center point's Y axis position
*'''fZ:''' The collision circle's center point's Z axis position
*'''radius''' The radius of the collision circle

===Returns===
Returns a [[colshape]] element if successful, ''false'' if invalid arguments were passed to the function.

==Example==
<section name="Server" class="server" show="true">
This example displays a chat message when a player enters the colshape and allows the colshape to be created using a console function ''set_zone''.
<syntaxhighlight lang="lua">
theZone = false

function shapeHit ( thePlayer )
outputChatBox ( getClientName ( thePlayer ) .. " is in the zone!" ) -- display a message in everyone's chat box
end

function setZone ( playerSource, commandName, fX, fY, fZ )
if ( fZ and fY and fX ) then -- check we've got all 3 args we need
local tempCol = createColCircle ( fX, fY, fZ, 10.0 ) -- create a col
if ( tempCol == false ) then -- did the col get created successfully?
outputConsole ( "Syntax is: set_zone <X> <Y> <Z>" ) -- inform the user what the valid syntax is
else
if ( theZone ~= false ) then -- did we already have a zone?
destroyElement ( theZone ) -- if so, destroy it
else
addEventHandler ( "onColShapeHit", theZone, shapeHit ) -- add a handler for the onColShapeHit event
end
theZone = tempCol -- and store the new zone we've made
outputChatBox ( "Zone has moved!" ) -- and tell everyone
end
end
end
addCommandHandler ( "set_zone", setZone ) -- add a console function called set_zone that will trigger the function setZone
</syntaxhighlight>
</section>

==See Also==
{{Collision shape functions}}
[[Category:Needs_Example]]

IsLineOfSightClear

2007-11-18T03:30:59Z

TalidanOld:

__NOTOC__
{{Client function}}
This function checks if there are obstacles between two points of the game world, optionally ignoring certain kinds of elements.

==Syntax==
<syntaxhighlight lang="lua">
bool isLineOfSightClear ( float startX, float startY, float startZ, float endX, float endY, float endZ, [ bool checkBuildings, bool checkVehicles, bool checkPeds, bool checkObjects, bool checkDummies, bool seeThroughStuff, bool ignoreSomeObjectsForCamera, element ignoredElement ] )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The first point's world X coordinate.
*'''startY:''' The first point's world Y coordinate.
*'''startZ:''' The first point's world Z coordinate.
*'''endX:''' The second point's world X coordinate.
*'''endY:''' The second point's world X coordinate.
*'''endZ:''' The second point's world X coordinate.

===Optional Arguments===
{{OptionalArg}}
*'''checkBuildings:''' Allow the line of sight to be blocked by GTA's internally placed buildings, i.e. the world map.
*'''checkVehicles:''' Allow the line of sight to be blocked by [[Vehicle|vehicles]].
*'''checkPeds:''' Allow the line of sight to be blocked by peds, i.e. [[Player|players]].
*'''checkObjects:''' Allow the line of sight to be blocked by [[Object|objects]].
*'''checkDummies:''' Allow the line of sight to be blocked by GTA's internal dummies. These are not used in the current MTA version so this argument can be set to ''false''.
*'''seeThroughStuff:''' Allow the line of sight to be blocked by translucent game objects, e.g. glass.
*'''ignoreSomeObjectsForCamera:''' Allow the line of sight to be blocked by certain objects.
*'''shootThroughStuff:''' Allow the line of sight to be blocked by certain entities.
*'''ignoredElement:''' Allow the line of sight to pass through a certain specified element.

===Returns===
Returns ''true'' if the line between the specified points is clear, ''false'' if there's an obstacle or if invalid parameters are passed.

==Example==
This page does not have an example
<syntaxhighlight lang="lua">
--add an example here
</syntaxhighlight>

==See Also==
{{Client world functions}}
[[Category:Needs_Example]]

CallRemote

2007-11-18T02:24:40Z

TalidanOld:

__NOTOC__
{{Server function}}
This function allows you to call functions that have been exported with HTTP access by other MTA servers. The calls are asynchronous so you do not get an immediate result from the call. You can also use this function to access any standard web page by specifying the URL.

Data is passed to the web page via HTTP POST as ''raw'' [[JSON]] data. The page should return JSON formated data in the page's body.

Note: You can read raw HTTP POST data from PHP using:
<syntaxhighlight lang="lua">[php]
file_get_contents('php://input')
</syntaxhighlight>
There are various libraries available for parsing JSON data into PHP variables and vice-versa.

==Syntax==
<syntaxhighlight lang="lua">
bool callRemote ( string host, string resourceName, string functionName, function callback, [ arguments... ] )
</syntaxhighlight>
'''OR'''
<syntaxhighlight lang="lua">
bool callRemote ( string URL, function callback, [ arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''host:''' This is a host name (and optionally port) of the server you wish to connect to.
*'''resourceName:''' This is a name of the resource that contains the exported function you want to call.
*'''functionName:''' This is a string with the name of the function which you want to call.
*'''URL:''' A full URL in the format ''<nowiki>http://hostname/path/file.ext</nowiki>''. A port can be specified with a colon followed by a port number appended to the hostname.
*'''callback:''' This is the function that should receive the data returned from the remote function call. The argument list should match the format of the data returned.

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when it is called. Any number of arguments of can be specified, each being passed to the designated function.

===Returns===
Returns ''true'' if the function has been called, ''false'' otherwise.

==Example==
Example needed!
<syntaxhighlight lang="lua">

</syntaxhighlight>

==See Also==
{{Resource_functions}}
[[Category:Needs_Example]]