https://wiki.multitheftauto.com/api.php?action=feedcontributions&feedformat=atom&user=Vandalite 2026-04-14T20:52:40Z User contributions MediaWiki 1.39.3 https://wiki.multitheftauto.com/index.php?title=Template:Resource_functions&diff=7030 2007-01-10T18:30:43Z

<p>Vandalite: </p> <hr /> <div>*[[getResources]]<br /> <br /> *[[getResourceInfo]]<br /> <br /> *[[getResourceState]]<br /> <br /> *[[startResource]]<br /> <br /> *[[stopResource]]<br /> <br /> *[[restartResource]]<br /> <br /> *[[getThisResource]]<br /> <br /> *[[getResourceFiles]]<br /> <br /> *[[getResourceFileType]]<br /> <br /> *[[getResourceConfig]]<br /> <br /> *[[getResourceFunctions]]<br /> <br /> *[[getResourceFunctionLevel]]<br /> <br /> *[[getResourceFunctionHttp]]<br /> <br /> *[[call]]<br /> <br /> *[[getIncludedResources]]<br /> <br /> *[[getResourceConfigLevel]]<br /> <br /> *[[refreshResources]]<br /> <br /> *[[setMapDimension]]<br /> <br /> *[[getResourceLoadFailureReason]]</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=Template:Resource_functions&diff=7029 2007-01-10T18:18:58Z

<p>Vandalite: </p> <hr /> <div>*[[getResources]]<br /> <br /> *[[getResourceInfo]]<br /> <br /> *[[getResourceState]]<br /> <br /> *[[startResource]]<br /> <br /> *[[stopResource]]<br /> <br /> *[[restartResource]]<br /> <br /> *[[getThisResource]]<br /> <br /> *[[getResourceFiles]]<br /> <br /> *[[getResourceFileType]]<br /> <br /> *[[getResourceConfig]]<br /> <br /> *[[getResourceFunctions]]<br /> <br /> *[[getResourceFunctionLevel]]<br /> <br /> *[[getResourceFunctionHttp]]<br /> <br /> *[[call]]<br /> <br /> *[[getIncludedResources]]<br /> <br /> *[[getResourceConfigLevel]]<br /> <br /> *[[refreshResources]]<br /> <br /> *[[setMapDimension]]</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=Server_Scripting_Functions&diff=7028 2007-01-10T18:13:16Z

<p>Vandalite: </p> <hr /> <div>This page lists all the scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]<br /> <br /> Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. These scripting functions are non-native and require the module to be loaded in order to work.<br /> <br /> Head over to [[Module functions]] for a list of non-native functions and modules that are available.<br /> <br /> <br /> <br /> ==Important Reminder: Works in Progress==<br /> Check the [[Main Page]]'s 'works in progress' section. There are other things being developed that need feedback immediately!<br /> <br /> ==Unfinished Functions==<br /> &lt;div style=&quot;border:3px solid red;margin-bottom:3px;padding-left:10px;&quot;&gt;&lt;div style=&quot;float:right;padding-right:5px;font-weight:bold;&quot;&gt;&lt;/div&gt;<br /> *'''NEED SYNTAX, MTA TEAM:''' [[:Category:Need Syntax]]<br /> &lt;/div&gt;<br /> *'''Incomplete Functions:''' [[:Category:Incomplete]]<br /> ** [[Complete list of scripting functions | Wiki source function list]] Wiki-created function list for quickview and double-checking<br /> *'''Incomplete Events List:''' [[:Category:Incomplete Event]]<br /> *'''Written material accuracy/completion check:''' [[:Category:Needs Checking]]<br /> <br /> ''If you wish to assist Ransom in adding new (red) functions to the incomplete list, see [[User:Ransom|Ransom's profile]] for the proper steps.''<br /> <br /> ''Please follow the style of the [[TextCreateTextItem|textCreateTextItem]] to document functions.''<br /> <br /> ==Account functions==<br /> {{Account_functions}}<br /> <br /> ==Admin functions==<br /> {{Admin_functions}}<br /> <br /> ==Audio functions==<br /> {{Audio_functions}}<br /> <br /> ==All Seeing Eye functions==<br /> {{ASE_functions}}<br /> <br /> ==Blip functions==<br /> {{Blip_functions}}<br /> <br /> ==Camera functions==<br /> {{Camera functions}}<br /> <br /> ==Collision shape functions==<br /> {{Collision shape functions}}<br /> <br /> ==Client functions==<br /> {{Client functions}}<br /> <br /> ==Clothes and body functions==<br /> {{Clothes and body functions}}<br /> <br /> ==Cursor functions==<br /> {{Cursor_functions}}<br /> <br /> ==Element functions==<br /> {{Element functions}}<br /> <br /> ==Event functions==<br /> {{Event_functions}}<br /> <br /> ==Explosion functions==<br /> {{Explosion_functions}}<br /> <br /> ==Fire functions==<br /> {{Fire_functions}}<br /> <br /> ==GUI functions==<br /> {{GUI_functions}}<br /> <br /> ==Input functions==<br /> {{Input_functions}}<br /> <br /> ==Map functions==<br /> {{Map_functions}}<br /> <br /> ==Marker functions==<br /> {{Marker functions}}<br /> <br /> ==Object functions==<br /> {{Object functions}}<br /> <br /> ==Pickup functions==<br /> {{Pickup functions}}<br /> <br /> ==Player functions==<br /> {{Player functions}}<br /> <br /> ==Radar area functions==<br /> {{Radar area functions}}<br /> <br /> ==Resource functions==<br /> {{Resource functions}}<br /> <br /> ==Scoreboard functions==<br /> {{Scoreboard functions}}<br /> <br /> ==Server functions==<br /> {{Server functions}}<br /> <br /> ==Spawnpoint functions==<br /> {{Spawnpoint functions}}<br /> <br /> ==SQL functions==<br /> {{SQL_functions}}<br /> <br /> ==Team functions==<br /> {{Team functions}}<br /> <br /> ==Text functions==<br /> {{Text functions}}<br /> <br /> ==Utility functions==<br /> {{Utility functions}}<br /> <br /> ==Vehicle functions==<br /> {{Vehicle functions}}<br /> <br /> ==Weapon functions==<br /> {{Weapon functions}}<br /> <br /> ==World functions==<br /> {{World functions}}<br /> <br /> ==XML functions==<br /> {{XML functions}}<br /> <br /> ==Deprecated Functions==<br /> Access: [http://www.mtavc.com/once-upon_a_time-there_was-this_girl/index.php?title=Category:Deprecated &lt;nowiki&gt;[[Category:Depreciated]]&lt;/nowiki&gt; ]&lt;br&gt;<br /> ''Note: dont change this, done purposely to keep this page from being included in the listing.''</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=User:EAi/Server_Console_Commands&diff=6985 2007-01-02T21:02:22Z

<p>Vandalite: </p> <hr /> <div>This is a list of current server console commands, in order to find which could be scripted.<br /> <br /> Comments Added by [[User:Vandalite|Vandalite]]<br /> Nearly Every command can be exported to a lua command, and accessed through a main command resource, with security considerations coded. only core resources will be noted as needed console commands.<br /> <br /> * say -- This is a CORE console command. needed if lua breaks down, for debugging.<br /> * teamsay<br /> * asay -- What's this?<br /> * msg<br /> * amsg -- What's this?<br /> * me -- What's this? -- i know what it is in IRC, does it work here?<br /> * slap -- What's this? -- i know what it is in IRC, does it work here?<br /> * nick<br /> * vote<br /> * maps<br /> * login<br /> * logout<br /> * setlevel<br /> * chgmypass<br /> * addaccount<br /> * delaccount<br /> * chgpass<br /> * chglevel<br /> * startmap -- Deprecated. loadresource will make this redundant.<br /> * restartmap -- Deprecated. loadresouce will make this redundant.<br /> * mute<br /> * unmute<br /> * kick<br /> * ban<br /> * banip<br /> * unbanip<br /> * shutdown<br /> * aexec -- What's this?<br /> * whois -- What's this? -- i know what it is in IRC, does it work here?<br /> * whowas -- What's this? -- i know what it is in IRC, does it work here?<br /> * loadscript<br /> ** legacy. consider changing to loadresource -- This is a CORE console command. needed if lua breaks down, for debugging.<br /> * unloadscript<br /> ** legacy. consider changing to unloadresource -- This is a CORE console command. needed if lua breaks down, for debugging.<br /> * scripts<br /> * debugscript -- This is a CORE console command. needed if lua breaks down, for debugging.<br /> <br /> For all dunctions i reccomended putting in the security resource. this is only useful if you have a way of setting functions (from mta server conf) to a security level. This allows ONLY the security resource to run these commands (since it's lua), and will only do so if the user has logged in, and communicates with the resource (with console command handlers). This allows easy modifications to the security systems, without needing to reboot the server. Besides, as you said, the more control you have from lua, the better.<br /> <br /> It should also be noted that various automated things that MTA does now, using map configurations, like respawn, and weapon drops should be exported to resource modules. bring the MTA automated systems completely down, and let lua do it, with simple commands like spawnplayer and spawnweapon. This gives ultimate control over what goes in the map files (or i should say, resource config files). It'll come in handy for gamemodes that need special respawn controls. (i'm thinking gang wars).<br /> <br /> A lot of this you already know, but i put it down cause you're not the only one who might read this.</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=User:EAi/Server_Console_Commands&diff=6980 2007-01-02T20:13:28Z

<p>Vandalite: </p> <hr /> <div>This is a list of current server console commands, in order to find which could be scripted.<br /> <br /> Comments Added by [[User:Vandalite|Vandalite]]<br /> <br /> * say<br /> * teamsay<br /> ** Exportable using msg -- may not be a bad idea to keep this one though, and have a wrapper instead for team assignment.<br /> * asay<br /> ** What's this? is it needed?<br /> * msg<br /> * amsg<br /> ** What's this? is it needed?<br /> * me<br /> ** What's this? is it needed?<br /> * slap<br /> ** What's this? is it needed?<br /> * nick<br /> * vote<br /> ** Exportable using mapvote resource<br /> * maps<br /> ** Exportable using mapvote resource<br /> * login<br /> ** Should have a lua wrapper with security resource<br /> * logout<br /> ** Should have a lua wrapper with security resource<br /> * setlevel<br /> ** Should have a lua wrapper with security resource<br /> * chgmypass<br /> ** Should have a lua wrapper with security resource<br /> * addaccount<br /> ** Should have a lua wrapper with security resource<br /> * delaccount<br /> ** Should have a lua wrapper with security resource<br /> * chgpass<br /> ** Should have a lua wrapper with security resource<br /> * chglevel<br /> ** Should have a lua wrapper with security resource<br /> * startmap<br /> ** Should have a lua wrapper with mapvote resource<br /> * restartmap<br /> ** Exportable using mapvote resource<br /> * mute<br /> ** Exportable using communications resource (and onPlayerChat interruptions)<br /> * unmute<br /> ** Exportable using communications resource (and onPlayerChat interruptions)<br /> * kick<br /> ** Should have a lua wrapper with security resource<br /> * ban<br /> ** Should have a lua wrapper with security resource<br /> * banip<br /> ** Should have a lua wrapper with security resource<br /> * unbanip<br /> ** Should have a lua wrapper with security resource<br /> * shutdown<br /> * aexec<br /> ** What's this? is it needed?<br /> * whois<br /> ** What's this? is it needed?<br /> * whowas<br /> ** What's this? is it needed?<br /> * loadscript<br /> ** legacy. consider changing to loadresource<br /> * unloadscript<br /> ** legacy. consider changing to unloadresource<br /> * scripts<br /> ** What's this? is it needed?<br /> * debugscript<br /> <br /> For all commands i reccomended putting in the security resource, this is only useful if you have a way of setting commands (from mta server conf) to a security level higher than ANY user, and an architecture is in place to allow resources themselves to have security levels. this allows ONLY the security resource to run these commands, and will only do so if the user has logged in, and communicates with the resource (with console command handlers). This allows easy modifications to the security systems, without needing to reboot the server. Besides, as you said, the more control you have from lua, the better.<br /> <br /> It should also be noted that various automated things that MTA does now, using map configurations, like respawn, and weapon drops should be exported to resource modules. bring the MTA automated systems completely down, and let lua do it, with simple commands like spawnplayer and spawnweapon. This gives ultimate control over what goes in the map files (or i should say, resource config files). It'll come in handy for gamemodes that need special respawn controls. (i'm thinking gang wars).<br /> <br /> A lot of this you already know, but i put it down cause you're not the only one who might read this.</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=WarpPlayerIntoVehicle&diff=6098 2006-10-23T04:39:20Z

<p>Vandalite: /* Example */</p> <hr /> <div>__NOTOC__ <br /> This function is used to warp or force a player into a vehicle. There are no animations involved when this happens.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool warpPlayerIntoVehicle ( player player, vehicle vehicle, [ int seat=0 ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''player:''' The player in which you wish to force inside the vehicle<br /> *'''vehicle:''' The vehicle you wish to force the player inside<br /> <br /> ===Optional Arguments=== <br /> {{OptionalArg}} <br /> *'''seat:''' An integer representing the seat ID. ''0'' represents the driver, any higher represent passenger seats<br /> <br /> ===Returns===<br /> Returns ''true'' if the operation is successful, ''false'' otherwise.<br /> <br /> ==Example== <br /> This example creates a vehicle and warps a player inside immediately<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> addCommandHandler ( startrace, createstartvehicles ) --add a command to start race<br /> function createstartvehicles ( playerSource, commandName, car, x, y, z ) --the function allows specification of your car, and the position<br /> racevehicle = createVehicle ( car, x, y, z ) --create a vehicle at a position specified by the startrace command<br /> warpPlayerIntoVehicle ( playerSource, racevehicle ) --warp them straight into the vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Player functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=Template:Player_functions&diff=6097 2006-10-23T04:38:13Z

<p>Vandalite: </p> <hr /> <div>* [[addPlayerClothes]]<br /> * [[canPlayerUseFunction]]<br /> * [[doesPlayerHaveJetPack]]<br /> * [[getPlayerArmor]]<br /> * [[getPlayerClothes]]<br /> * [[getPlayerCount]]<br /> * [[getPlayerCurrentWeaponAmmoInClip]]<br /> * [[getPlayerCurrentWeaponID]]<br /> * [[getPlayerFromNick]]<br /> * [[getPlayerHealth]]<br /> * [[getPlayerLevel]]<br /> * [[getPlayerMoney]]<br /> * [[getPlayerOccupiedVehicle]]<br /> * [[getPlayerOccupiedVehicleSeat]]<br /> * [[getPlayerPing]]<br /> * [[getPlayerRotation]]<br /> * [[getPlayerSkin]]<br /> * [[getPlayerSourceIP]]<br /> * [[getPlayerStat]]<br /> * [[getPlayerTarget]]<br /> * [[getPlayerTeam]]<br /> * [[getRandomPlayer]]<br /> * [[getWantedLevel]]<br /> * [[givePlayerJetPack]]<br /> * [[givePlayerMoney]]<br /> * [[isPlayerDead]]<br /> * [[isPlayerDucked]]<br /> * [[isPlayerInVehicle]]<br /> * [[isPlayerMuted]]<br /> * [[isPlayerOnGround]]<br /> * [[isPlayerUnderWater]]<br /> * [[isPlayerScoreboardForced]]<br /> * [[isPlayerMapForced]]<br /> * [[getAlivePlayers]]<br /> * [[getDeadPlayers]]<br /> * [[getPlayerTask]]<br /> * [[getPlayerSimplestTask]]<br /> * [[isPlayerDoingTask]]<br /> * [[killPlayer]]<br /> * [[removePlayerClothes]]<br /> * [[removePlayerFromVehicle]]<br /> * [[removePlayerJetPack]]<br /> * [[setPlayerArmor]]<br /> * [[setPlayerHealth]]<br /> * [[setPlayerMoney]]<br /> * [[setPlayerRotation]]<br /> * [[setPlayerSkin]]<br /> * [[setPlayerStat]]<br /> * [[setWantedLevel]]<br /> * [[showPlayerHudComponent]]<br /> * [[spawnPlayer]]<br /> * [[spawnPlayerAtSpawnpoint]]<br /> * [[takePlayerMoney]]<br /> * [[warpPlayerIntoVehicle]]<br /> * [[forcePlayerScoreboard]]<br /> * [[forcePlayerMap]]</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=WarpPlayerIntoVehicle&diff=6096 2006-10-23T04:37:43Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function is used to warp or force a player into a vehicle. There are no animations involved when this happens.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool warpPlayerIntoVehicle ( player player, vehicle vehicle, [ int seat=0 ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''player:''' The player in which you wish to force inside the vehicle<br /> *'''vehicle:''' The vehicle you wish to force the player inside<br /> <br /> ===Optional Arguments=== <br /> {{OptionalArg}} <br /> *'''seat:''' An integer representing the seat ID. ''0'' represents the driver, any higher represent passenger seats<br /> <br /> ===Returns===<br /> Returns ''true'' if the operation is successful, ''false'' otherwise.<br /> <br /> ==Example== <br /> This example creates a vehicle and warps a player inside immediately<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> addCommandHandler ( startrace, createstartvehicles ) --add a command to start race<br /> function createstartvehicles ( playerSource, commandName, car, x, y, z ) --the function allows specification of your car, and the position<br /> racevehicle = createVehicle ( car, x, y, z ) --create a vehicle at a position specified by the startrace command<br /> warpPlayerintoVehicle ( playerSource, racevehicle ) --warp them straight into the vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Player functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=WarpPlayerintoVehicle&diff=6095 2006-10-23T04:37:15Z

<p>Vandalite: WarpPlayerintoVehicle moved to WarpPlayerIntoVehicle: Syntax correction</p> <hr /> <div>#redirect [[WarpPlayerIntoVehicle]]</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=WarpPlayerIntoVehicle&diff=6094 2006-10-23T04:37:15Z

<p>Vandalite: WarpPlayerintoVehicle moved to WarpPlayerIntoVehicle</p> <hr /> <div>__NOTOC__ <br /> This function is used to warp or force a player into a vehicle. There are no animations involved when this happens.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool warpPlayerintoVehicle ( player player, vehicle vehicle, [ int seat=0 ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''player:''' The player in which you wish to force inside the vehicle<br /> *'''vehicle:''' The vehicle you wish to force the player inside<br /> <br /> ===Optional Arguments=== <br /> {{OptionalArg}} <br /> *'''seat:''' An integer representing the seat ID. ''0'' represents the driver, any higher represent passenger seats<br /> <br /> ===Returns===<br /> Returns ''true'' if the operation is successful, ''false'' otherwise.<br /> <br /> ==Example== <br /> This example creates a vehicle and warps a player inside immediately<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> addCommandHandler ( startrace, createstartvehicles ) --add a command to start race<br /> function createstartvehicles ( playerSource, commandName, car, x, y, z ) --the function allows specification of your car, and the position<br /> racevehicle = createVehicle ( car, x, y, z ) --create a vehicle at a position specified by the startrace command<br /> warpPlayerintoVehicle ( playerSource, racevehicle ) --warp them straight into the vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Player functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=BindKey&diff=5978 2006-10-09T16:58:27Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> Binds a player's key to a console command, which will be triggered when the key is pressed.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;bindKey ( player thePlayer, string key, [ string keyState ], string command, [ string arguments ] ) &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''thePlayer:''' The player you wish to bind the key of.<br /> *'''key:''' The key or control you wish to bind to the command. See [[Key names]] for a list of possible keys and [[control names]] for a list of possible controls.<br /> *'''command:''' The command that will be triggered when the player's key is pressed. See [[Control names]] for a list of GTA keys that can be used.<br /> <br /> ===Optional Arguments===<br /> *'''keyState:''' A string containing the word &quot;up&quot; or &quot;down&quot; determining when the binded command will be called. Defaults to &quot;down&quot; if not specified.<br /> *'''arguments:''' Any arguments you may want to pass to the command handler when the key is pressed by the user. all arguments go into one string. the command handler will split them up into separate arguments later.<br /> <br /> ==Example== <br /> '''Example 1:''' This example will bind a player's 'F1' key to a pair of console command.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> addCommandHandler ( &quot;bindme&quot;, &quot;bindthekeys&quot; )<br /> function bindthekeys ( source )<br /> bindKey ( source, &quot;F1&quot;, &quot;down&quot;, &quot;keydown&quot; ) -- bind the player's F1 down key<br /> bindKey ( source, &quot;F1&quot;, &quot;up&quot;, &quot;keyup&quot; ) -- bind the player's F1 up key<br /> end<br /> <br /> addCommandHandler ( &quot;keydown&quot;, &quot;funKeydown&quot; )<br /> function funKeydown ( source )<br /> outputChatBox ( getClientName ( source )..&quot; pressed the F1 key&quot; )<br /> end<br /> <br /> addCommandHandler ( &quot;keyup&quot;, &quot;funcKeyup&quot; )<br /> function funcKeyup ( source )<br /> outputChatBox ( getClientName ( source )..&quot; let go of the F1 key&quot; )<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> '''Example 2:''' This example will bind a player's handbrake key to a console command. This takes advantage of the fact you can bind a key to a controller function, so that whatever key the player has bound locally this will work. This allows reliable notification as to when the player is pressing a particular key in-game. An easier, lower bandwidth but less reliable method is to use [[getControlState]].<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> addEventHandler ( &quot;onPlayerJoin&quot;, getRootElement(), &quot;playerJoin&quot; )<br /> function playerJoin ()<br /> bindKey ( source, &quot;handbrake&quot;, &quot;down&quot;, &quot;handbrakePressed&quot;, &quot;1&quot; )<br /> bindKey ( source, &quot;handbrake&quot;, &quot;up&quot;, &quot;handbrakePressed&quot;, &quot;0&quot; )<br /> end<br /> <br /> addCommandHandler ( &quot;handbrakePressed&quot;, &quot;handbrakePressed&quot; )<br /> function handbrakePressed ( source, commandName, isDown )<br /> if ( isDown == &quot;1&quot; )<br /> outputChatBox ( getClientName ( source ) .. &quot; is using the handbrake!&quot; )<br /> else<br /> outputChatBox ( getClientName ( source ) .. &quot; has stopped using the handbrake!&quot; )<br /> end<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> '''Example 3:''' This example shows how you can support moddifier keys, i.e. two keys held at once.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> addEventHandler ( &quot;onPlayerJoin&quot;, getRootElement(), &quot;playerJoin&quot; )<br /> function playerJoin ()<br /> bindKey ( source, &quot;lshift&quot;, &quot;down&quot;, &quot;keyPressed&quot;, &quot;lshiftKey&quot;, &quot;1&quot; )<br /> bindKey ( source, &quot;lshift&quot;, &quot;up&quot;, &quot;keyPressed&quot;, &quot;lshiftKey&quot;, &quot;0&quot; )<br /> <br /> bindKey ( source, &quot;q&quot;, &quot;down&quot;, &quot;keyPressed&quot;, &quot;qKey&quot;, &quot;1&quot; )<br /> bindKey ( source, &quot;q&quot;, &quot;up&quot;, &quot;keyPressed&quot;, &quot;qKey&quot;, &quot;0&quot; )<br /> end<br /> <br /> -- Called when either of the two bound keys are pressed<br /> addCommandHandler ( &quot;keyPressed&quot;, &quot;keyPressed&quot; )<br /> function keyPressed( source, commandName, keyName, isDown )<br /> setElementData ( source, keyName, isDown )<br /> end<br /> <br /> -- Call this function every 100ms to check for players keys. Could be sped up by <br /> -- caching the players table and updating that only onPlayerJoin and onPlayerQuit.<br /> setTimer ( &quot;keyProcess&quot;, 100, 0 )<br /> function keyProcess ( )<br /> players = getElementsByType ( &quot;player&quot; )<br /> for playerKey, playerValue in players do<br /> checkPlayerKeys ( playerValue )<br /> end<br /> end<br /> <br /> -- Called for each player to check if they're pressing shift + q<br /> function checkPlayerKeys ( thePlayer )<br /> if ( getElementData ( thePlayer, &quot;lshift&quot; ) == 1 and getElementData ( thePlayer, &quot;q&quot; ) == 1 ) then<br /> outputChatBox ( thePlayer, &quot;Shift + Q pressed!&quot; )<br /> end<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Input functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=WarpPlayerIntoVehicle&diff=4842 2006-09-10T05:39:17Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function is used to warp or force a player into a vehicle. There are no animations involved when this happens.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool warpPlayerintoVehicle ( player player, vehicle vehicle, [ int seat=0 ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''player:''' The player in which you wish to force inside the vehicle<br /> *'''vehicle:''' The vehicle you wish to force the player inside<br /> <br /> ===Optional Arguments=== <br /> {{OptionalArg}} <br /> *'''seat:''' An integer representing the seat ID. ''0'' represents the driver, any higher represent passenger seats<br /> <br /> ===Returns===<br /> Returns ''true'' if the operation is successful, ''false'' otherwise.<br /> <br /> ==Example== <br /> This example creates a vehicle and warps a player inside immediately<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> addCommandHandler ( startrace, createstartvehicles ) --add a command to start race<br /> function createstartvehicles ( playerSource, commandName, car, x, y, z ) --the function allows specification of your car, and the position<br /> racevehicle = createVehicle ( car, x, y, z ) --create a vehicle at a position specified by the startrace command<br /> warpPlayerintoVehicle ( playerSource, racevehicle ) --warp them straight into the vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Player functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=SetElementVelocity&diff=4841 2006-09-10T05:28:01Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> This function sets the velocity (movement speeds) along each axis, for an element.<br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;bool setElementVelocity ( element theElement, float speedX, float speedY, float speedZ )&lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''theElement''': The [[element]] you wish to set the velocity of.<br /> *'''speedX''': A floating point value determining the speed along the X axis.<br /> *'''speedY''': A floating point value determining the speed along the Y axis.<br /> *'''speedZ''': A floating point value determining the speed along the Z axis.<br /> <br /> ===Returns===<br /> Returns ''true'' if the speed was set successfully, ''false'' if a bad element was specified or other bad arguments.<br /> <br /> ==Example==<br /> This example 'copies' the speed of a specific player (called ''someguy'' in this example) to another player (called ''Ted'' in this example).<br /> <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> speedx, speedy, speedz = getElementVelocity ( getPlayerFromNick ( &quot;someguy&quot; ) ) -- get the velocity of the player named &quot;someguy&quot;<br /> setElementVelocity ( getPlayerFromNick ( &quot;Ted&quot; ), speedx, speedy, speedz ) -- copy the velocity to a player named &quot;Ted&quot;<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=SetElementID&diff=4555 2006-08-22T17:08:48Z

<p>Vandalite: </p> <hr /> <div>[[Category:Incomplete]]<br /> __NOTOC__ <br /> This function sets the ''ID'' of an ''element'' to a ''string''. This can be anything from an identifying number, to a name.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool setElementID ( element theElement, string name ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The ''element'' you want to set the ID of.<br /> *'''name:''' The ID you want to set to ''theElement''<br /> <br /> ===Returns===<br /> This returns ''true'' if sucessful. It will return false if ''theElement'' is invalid, or does not exist, or if ''name'' is invalid, or is not a string.<br /> <br /> ==Example== <br /> <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> Example goes here...<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=SetElementID&diff=4554 2006-08-22T17:06:02Z

<p>Vandalite: </p> <hr /> <div>[[Category:Incomplete]]<br /> __NOTOC__ <br /> This function sets the ''ID'' of an ''element'' to a ''string''. This can be anything from an identifying number, to a name.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool setElementID ( element theElement, string name ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The ''element'' you want to set the ID of.<br /> *'''name:'' The ID you want to set to ''theElement''<br /> <br /> ===Returns===<br /> This returns ''true'' if sucessful. It will return false if ''theElement'' is invalid, or does not exist, or if ''name'' is invalid, or is not a string.<br /> <br /> ==Example== <br /> <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> Example goes here...<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementsByType&diff=4551 2006-08-22T15:30:18Z

<p>Vandalite: </p> <hr /> <div>[[category:incomplete]]<br /> __NOTOC__ <br /> This function is used to retreive a list of all elemets of the specified type. This can be useful, as it disregards ''where'' in the element table it is in the element heirarchy.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> table getElementsByType ( string type ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''type:''' The type of element you want a list of. This can be any one of the following ten things MTA is programmed to understand:<br /> **'''&quot;player&quot;:''' A player connected to the server<br /> **'''&quot;vehicle&quot;:''': A vehicle<br /> **'''&quot;object&quot;:''' An object<br /> **'''&quot;pickup&quot;:''' A pickup<br /> **'''&quot;blip&quot;:''' A blip<br /> **'''&quot;marker&quot;:''' A marker<br /> **'''&quot;spawnpoint&quot;:''' A spawnpoint<br /> **'''&quot;remoteclient&quot;:''' A remote client connected to the server<br /> **'''&quot;console&quot;:''' The server Console<br /> **'''&quot;unknown&quot;:''' Unknown element type<br /> <br /> ===Returns===<br /> Returns a ''table'' containing all the elements of the specified type. Returns an empty ''table'' if there are no elements of the specified type. Returns ''false'' if the string specified is invalid (or not a string).<br /> <br /> ==Example== <br /> TODO: add an example here.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> Add example here...<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementType&diff=4550 2006-08-22T15:20:35Z

<p>Vandalite: </p> <hr /> <div>[[category:incomplete]]<br /> __NOTOC__ <br /> This function is used to retrieve the type of an Element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> string getElementType ( element theElement ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element you wish to get the type of.<br /> <br /> ===Returns===<br /> There are a total of 10 strings this function returns:<br /> *'''&quot;player&quot;:''' A player connected to the server<br /> *'''&quot;vehicle&quot;:''': A vehicle<br /> *'''&quot;object&quot;:''' An object<br /> *'''&quot;pickup&quot;:''' A pickup<br /> *'''&quot;blip&quot;:''' A blip<br /> *'''&quot;marker&quot;:''' A marker<br /> *'''&quot;spawnpoint&quot;:''' A spawnpoint<br /> *'''&quot;remoteclient&quot;:''' A remote client connected to the server<br /> *'''&quot;console&quot;:''' The server Console<br /> *'''&quot;unknown&quot;:''' Unknown element type<br /> <br /> This function will return ''false'' if ''theElement'' is invalid.<br /> <br /> ==Example== <br /> This example destroys a haystack when a player targets it<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Add an event, so the server knows to wait for someone to start targeting stuff<br /> addEventHandler ( &quot;onPlayerTargeted&quot;, root, &quot;onPlayerTargeted&quot; )<br /> --Add the function that runs when the event is tripped<br /> function onPlayerTargeted ( element )<br /> --If the targetted object is a haystack remove it from the game.<br /> if ( getElementType ( element ) == &quot;object&quot; ) and ( getObjectModel ( element ) == 3374 ) then<br /> destroyElement ( element )<br /> end<br /> end <br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementType&diff=4541 2006-08-22T15:14:02Z

<p>Vandalite: </p> <hr /> <div>[[category:incomplete]]<br /> __NOTOC__ <br /> This function is used to retrieve the type of an Element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> string getElementType ( element theElement ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element you wish to get the type of.<br /> <br /> ===Returns===<br /> There are a total of 10 strings this function returns:<br /> *'''&quot;player&quot;:''' A player connected to the server<br /> *'''&quot;vehicle&quot;:''': A vehicle<br /> *'''&quot;object&quot;:''' An object<br /> *'''&quot;pickup&quot;:''' A pickup<br /> *'''&quot;blip&quot;:''' A blip<br /> *'''&quot;marker&quot;:''' A marker<br /> *'''&quot;spawnpoint&quot;:''' A spawnpoint<br /> *'''&quot;remoteclient&quot;:''' A remote client connected to the server<br /> *'''&quot;console&quot;:''' The server Console<br /> *'''&quot;unknown&quot;:''' Unknown element type<br /> <br /> It is also possible to specify your own element types using [[setElementType]], or by specifying it in the xml file.<br /> <br /> This function will return ''false'' if ''theElement'' is invalid.<br /> <br /> ==Example== <br /> This example destroys a haystack when a player targets it<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Add an event, so the server knows to wait for someone to start targeting stuff<br /> addEventHandler ( &quot;onPlayerTargeted&quot;, root, &quot;onPlayerTargeted&quot; )<br /> --Add the function that runs when the event is tripped<br /> function onPlayerTargeted ( element )<br /> --If the targetted object is a haystack remove it from the game.<br /> if ( getElementType ( element ) == &quot;object&quot; ) and ( getObjectModel ( element ) == 3374 ) then<br /> destroyElement ( element )<br /> end<br /> end <br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementsByType&diff=4538 2006-08-22T15:06:46Z

<p>Vandalite: </p> <hr /> <div>[[category:incomplete]]<br /> __NOTOC__ <br /> This fake function is for use with blah &amp; blah and does blahblahblabhalbhl<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> table getElementsByType ( string type ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''argumentName:''' description<br /> <br /> ===Optional Arguments=== <br /> {{OptionalArg}} <br /> *'''argumentName2:''' descriptiona<br /> *'''argumentName3:''' description<br /> <br /> ===Returns===<br /> Returns ''true'' if blah, ''false'' otherwise.<br /> <br /> ==Example== <br /> This example does...<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --This line does...<br /> blabhalbalhb --abababa<br /> --This line does this...<br /> mooo<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{FunctionArea_Functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementParent&diff=4536 2006-08-22T15:05:00Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Incomplete]]<br /> This function is used to determine the parent of an ''element.''<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element getElementParent ( element theElement ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The child of the parent element you want returned.<br /> <br /> ===Returns===<br /> This returns the parent as an ''element''. It returns ''false'' if ''theElement'' is invalid, or is the root node.<br /> <br /> ==Example== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Add example here...<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CloneElement&diff=4535 2006-08-22T15:04:45Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Incomplete]]<br /> This function clones (creates an exact copy of) an already existing element. The root node, and player elements cannot be cloned. If a player element is a child of an element that is cloned, it will be skipped, along with the elements that exist as a child to the player element.<br /> <br /> Players are not the only elements that cannot be cloned. This list also includes remoteclinets, and console elements.<br /> <br /> The cloned element will be placed on the element tree as a child of the same parent as the cloned element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element cloneElement ( element theElement, [ float xOffset = 0, float yOffset = 0, float zOffset = 0, bool cloneChildren = false ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element that you wish to clone.<br /> <br /> ===Optional Arguments===<br /> {{OptionalArg}}<br /> * '''xOffset''': A floating point number representing the offset from the cloned element's X coordinate on the map.<br /> * '''yOffset''': A floating point number representing the offset from the cloned element's Y coordinate on the map.<br /> * '''zOffset''': A floating point number representing the offset from the cloned element's Z coordinate on the map.<br /> * '''cloneChildren''': A boolean value representing whether or not the element's children will be cloned.<br /> <br /> ===Returns===<br /> Returns the handle of the new cloned element of the parent.<br /> <br /> ==Example== <br /> This example clones the vehicle a player is in.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> if ( command == &quot;clone&quot; ) then<br /> x, y, z = getElementPosition ( source ) -- get the position of the player<br /> clone = cloneElement ( getPlayerOccupiedVehicle ( source ), 5, 0, 0 ) -- create a clone of the player's vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementVelocity&diff=4533 2006-08-22T15:02:26Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> ==Description==<br /> This function returns three floats containing the velocity (movement speeds) along the X, Y, and Z axis respectively. <br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;float float float getElementVelocity ( element theElement )&lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''theElement''': The [[element]] you wish to retrieve the velocity of.<br /> <br /> ===Returns===<br /> This function can fail if the element is a player in a car. Use the vehicle element in this case. It will also fail if the element specified does not have a velocity, or does not exist. If this function does fail, the first return value will be set to ''false''. Other than that though, this function will return three floats that represent the element's current velocity along the ''x'', ''y'', and ''z'' axis respectively.<br /> <br /> <br /> ==Example==<br /> This example retreives, calculates, and displays the speed of a player named ''someguy''.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --find a player named &quot;someguy&quot; and get his velocity.<br /> speedx, speedy, speedz = getElementVelocity ( findPlayer ( &quot;someguy&quot; ) )<br /> --use pythagorean theorem to get actual velocity<br /> --Raising something to the exponent of 0.5 is the same thing as taking a square root.<br /> actualspeed = (speedx^2 + speedy^2 + speedz^2)^(0.5) <br /> --report the results.<br /> outputChatBox ( &quot;Someguy's current Velocity: &quot; .. actualspeed .. &quot; arbitrary units.&quot; )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementVelocity&diff=4530 2006-08-22T15:01:30Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> ==Description==<br /> This function returns three floats containing the velocity (movement speeds) along the X, Y, and Z axis respectively. <br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;float float float getElementVelocity ( element theElement )&lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''theElement''': The [[element]] you wish to retrieve the velocity of.<br /> <br /> ===Returns===<br /> This function can fail if the element is a player in a car. Use the vehicle element in this case. It will also fail if the element specified does not have a velocity, or does not exist. If this function does fail, the first return value will be set to ''false''. Other than that though, this function will return three floats that represent the element's current velocity along the ''x'', ''y'', and ''z'' axis respectively.<br /> <br /> <br /> ==Example==<br /> --find a player named &quot;someguy&quot; and get his velocity.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;speedx, speedy, speedz = getElementVelocity ( findPlayer ( &quot;someguy&quot; ) )<br /> --use pythagorean theorem to get actual velocity<br /> --Raising something to the exponent of 0.5 is the same thing as taking a square root.<br /> actualspeed = (speedx^2 + speedy^2 + speedz^2)^(0.5) <br /> --report the results.<br /> outputChatBox ( &quot;Someguy's current Velocity: &quot; .. actualspeed .. &quot; arbitrary units.&quot; )&lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementVelocity&diff=4528 2006-08-22T14:58:39Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> ==Description==<br /> This function returns three floats containing the velocity (movement speeds) along the X, Y, and Z axis respectively. <br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;float float float getElementVelocity ( element theElement )&lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''theElement''': The [[element]] you wish to retrieve the velocity of.<br /> <br /> ===Returns===<br /> This function can fail if the element is a player in a car. Use the vehicle element in this case. It will also fail if the element specified does not have a velocity, or does not exist. If this function does fail, the first return value will be set to ''false''. Other than that though, this function will return three floats that represent the element's current velocity along the ''x'', ''y'', and ''z'' axis respectively.<br /> <br /> <br /> ==Example==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;speedx, speedy, speedz = getElementVelocity ( findPlayer ( &quot;someguy&quot; ) )<br /> actualspeed = (speedx^2 + speedy^2 + speedz^2)^(0.5) <br /> --Raising something to the exponent of 0.5 is the same thing as taking a square root.<br /> outputChatBox ( &quot;Someguy's current Velocity: &quot;, actualspeed, &quot; arbitrary units.&quot; )&lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementParent&diff=4526 2006-08-22T14:41:47Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function is used to determine the parent of an ''element.''<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element getElementParent ( element theElement ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The child of the parent element you want returned.<br /> <br /> ===Returns===<br /> This returns the parent as an ''element''. It returns ''false'' if ''theElement'' is invalid, or is the root node.<br /> <br /> ==Example== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Add example here...<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementID&diff=4525 2006-08-22T14:40:32Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function gets the ID of an element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> string getElementID ( element theElement ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' the element from which to retrive the ID.<br /> <br /> ===Returns===<br /> This returns a ''string'' containing the element ID. It will return an empty ''string'' if it has no ID. It will return false if the element is invalid.<br /> <br /> ==Example== <br /> To get the ID of the following element:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;&lt;flag id=&quot;northflag&quot; posX=&quot;2365&quot; posY=&quot;215&quot; posZ=&quot;32&quot;&gt;&lt;/syntaxhighlight&gt;<br /> You could use the following code:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> -- assume flag refers to the flag element in the above XML code<br /> idstring = getElementID ( flag ) -- get the id of the flag element<br /> outputChatBox ( &quot;The flag's ID is: &quot; .. idstring ) -- output: The flag's ID is: northflag<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementChildren&diff=4524 2006-08-22T14:39:07Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function is used to retreive a list of child elements as they appear in the element table. Without passing each element in the table through [[getElementType]], you wont know what you have though.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> table getElementChildren ( element parent ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''parent:''' Supply this argument with the parent of the children you want returned.<br /> <br /> ===Returns===<br /> This function returns a ''table'' that contains a list of elements that the parent has. If the element has no children, it will return an empy ''table''. It will return ''false'' if the parent element does not exist.<br /> <br /> ==Example== <br /> In a blank map with nothing but players, using this function will return a table with all the players in it.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Get root element<br /> root = getRootElement()<br /> --Get ALL of root's children<br /> mytable = getElementChildren(root)<br /> &lt;/syntaxhighlight&gt;<br /> At a later point you could loop through all the elements and process thier contents any way you wish. Remember to make sure you have the CURRENT list of elements though. If you get the root element children, then wait a while for things to change, this list won't be up to date unless you use [[getElementChildren]] again.<br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementParent&diff=4512 2006-08-22T04:21:26Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function is used to determine the parent of an ''element.''<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element getElementParent ( element theElement ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The child of the parent element you want returned.<br /> <br /> ===Returns===<br /> Returns an the parent as an ''element'', ''false'' if ''theElement'' is invalid, or is the root node.<br /> <br /> ==Example== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Add example here...<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementID&diff=4508 2006-08-22T04:10:00Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function gets the ID of an element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> string getElementID ( element theElement ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' the element from which to retrive the ID.<br /> <br /> ===Returns===<br /> Returns a string containing the element ID, or false if the element is invalid, or has no ID.<br /> <br /> ==Example== <br /> To get the ID of the following element:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;&lt;flag id=&quot;northflag&quot; posX=&quot;2365&quot; posY=&quot;215&quot; posZ=&quot;32&quot;&gt;&lt;/syntaxhighlight&gt;<br /> You could use the following code:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> -- assume flag refers to the flag element in the above XML code<br /> idstring = getElementID ( flag ) -- get the id of the flag element<br /> outputChatBox ( &quot;The flag's ID is: &quot; .. idstring ) -- output: The flag's ID is: northflag<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementData&diff=4506 2006-08-21T17:48:53Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> Elements can contain data values. These are accessable via names, and their value can be retrieved using [[getElementData]] and set using [[setElementData]]. These values are also loaded from the attributes in the XML map files, and as such can provide a powerful way to store and retrieve data in XML for each element.<br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;var getElementData ( element theElement, string name )&lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''theElement:''' This is the element with data you want to retreive.<br /> *'''name:''' The name of the element data entry you want to retrieve.<br /> <br /> ===Returns===<br /> This function returns a ''variable'' containing the requested element data, or ''false'' if the element data does not exist, or the element itself does not exist. Usually this is a ''string'' but it doesn't have to be.<br /> <br /> ==Example==<br /> This example will store the version of the map in the variable ''mapVersion''. Generally this will be ''2.0'' in the final release.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> map = getRootElement ( )<br /> mapVersion = getElementData ( map, &quot;version&quot; )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementData&diff=4505 2006-08-21T17:32:16Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> Elements can contain data values. These are accessable via names, and their value can be retrieved using [[getElementData]] and set using [[setElementData]]. These values are also loaded from the attributes in the XML map files, and as such can provide a powerful way to store and retrieve data in XML for each element.<br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;string getElementData ( element theElement, string name )&lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''theElement:''' This is the element with data you want to retreive.<br /> *'''name:''' The name of the element data entry you want to retrieve.<br /> <br /> ===Returns===<br /> This function returns a ''string'' containing the requested element data, or ''false'' if the element data does not exist, or the element itself does not exist.<br /> <br /> ==Example==<br /> This example will store the version of the map in the variable ''mapVersion''. Generally this will be ''2.0'' in the final release.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> map = getRootElement ( )<br /> mapVersion = getElementData ( map, &quot;version&quot; )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementChildrenCount&diff=4503 2006-08-21T17:20:36Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function returns the number of children an element has.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> int getElementChildrenCount ( element parent )<br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''parent:''' the parent element<br /> <br /> ===Returns===<br /> Returns the number of child elements, or false if the parent element does not exist.<br /> <br /> ==Example==<br /> To get the number of children the 'team1' element has:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> &lt;team1 id=&quot;red&quot;&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_0&quot; posX=&quot;2507.8715820313&quot; posY=&quot;2772.6071777344&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_1&quot; posX=&quot;2508.060546875&quot; posY=&quot;2780.3647460938&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_2&quot; posX=&quot;2508.0053710938&quot; posY=&quot;2776.2897949219&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_3&quot; posX=&quot;2510.6899414063&quot; posY=&quot;2778.3745117188&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;/team1&gt;&lt;/syntaxhighlight&gt;<br /> <br /> You could use the following code:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> teamRed = getElementByID ( &quot;red&quot; ) -- find the parent element by it's ID<br /> count = getElementChildrenCount ( teamRed ) -- get the total number of children<br /> outputChatBox ( &quot;Team red has &quot; .. count .. &quot; spawnpoints&quot; ) -- output: Team red has 4 spawnpoints<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementChildrenCount&diff=4502 2006-08-21T17:20:21Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function returns the number of children an element has.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> int getElementChildrenCount ( element parent )<br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''parent:''' the parent element<br /> <br /> ===Returns===<br /> Returns the number of child elements, or false if the parent element does not exist.<br /> <br /> ==Example==<br /> To get the number of children the 'team1' element has:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> &lt;team1 id=&quot;red&quot;&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_0&quot; posX=&quot;2507.8715820313&quot; posY=&quot;2772.6071777344&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_1&quot; posX=&quot;2508.060546875&quot; posY=&quot;2780.3647460938&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_2&quot; posX=&quot;2508.0053710938&quot; posY=&quot;2776.2897949219&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_3&quot; posX=&quot;2510.6899414063&quot; posY=&quot;2778.3745117188&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;/team1&gt;&lt;/syntaxhighlight&gt;<br /> <br /> You could use the following code:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> teamRed = getElementByID ( &quot;red&quot; ) -- find the parent element by it's ID<br /> count = getElementChildrenCount ( teamRed ) -- get the total number of children<br /> outputChatBox ( &quot;Team red has &quot; .. count .. &quot; spawnpoints&quot; ) -- output: Team red has 4 spawnpoints<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_Functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementChild&diff=4501 2006-08-21T17:18:26Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function returns an element based on it's parent.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element getElementChild ( element parent, int index ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''parent:''' the element above the one to be returned in the hierarchy.<br /> *'''index:''' the element's index (0 for the first element, 1 for the second, etc).<br /> <br /> ===Returns===<br /> Returns the requested element if it exists, or false if it doesn't.<br /> <br /> ==Example==<br /> To spawn a player at the red team's third spawnpoint:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> &lt;team1 id=&quot;red&quot;&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_0&quot; posX=&quot;2507.8715820313&quot; posY=&quot;2772.6071777344&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_1&quot; posX=&quot;2508.060546875&quot; posY=&quot;2780.3647460938&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_2&quot; posX=&quot;2508.0053710938&quot; posY=&quot;2776.2897949219&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;spawnpoint id=&quot;spawnpoint_3&quot; posX=&quot;2510.6899414063&quot; posY=&quot;2778.3745117188&quot; posZ=&quot;10.8203125&quot; rot=&quot;270&quot; skin=&quot;285&quot;/&gt;<br /> &lt;/team1&gt;&lt;/syntaxhighlight&gt;<br /> <br /> You could use the following code:<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> teamRed = getElementByID ( &quot;red&quot; ) -- find the parent element by it's ID and assign it to teamRed variable<br /> teamRedSpawn = getElementChild ( teamRed, 2 ) -- find teamRed's third child element (which happens to be a spawnpoint)<br /> spawnPlayer ( player, teamRedSpawn ) -- spawn a player at the spawnpoint<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementChildren&diff=4499 2006-08-21T17:09:41Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function is used to retreive a list of child elements as they appear in the element table. Without passing each element in the table through [[getElementType]], you wont know what you have though.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> table getElementChildren ( element parent ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''parent:''' Supply this argument with the parent of the children you want returned.<br /> <br /> ===Returns===<br /> This function returns a ''table'' that contains a list of elements that the parent has. If the element has no children, it will return ''false''. It will also return ''false'' if the parent element does not exist.<br /> <br /> ==Example== <br /> In a blank map with nothing but players, using this function will return a table with all the players in it.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Get root element<br /> root = getRootElement()<br /> --Get ALL of root's children<br /> mytable = getElementChildren(root)<br /> &lt;/syntaxhighlight&gt;<br /> At a later point you could loop through all the elements and process thier contents any way you wish. Remember to make sure you have the CURRENT list of elements though. If you get the root element children, then wait a while for things to change, this list won't be up to date unless you use [[getElementChildren]] again.<br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementChildren&diff=4498 2006-08-21T17:02:55Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function is used to retreive a list of child elements as they appear in the element table. Without passing each element in the table through [[getElementType]], you wont know what you have though.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> table getElementChildren ( element parent ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''parent:''' Supply this argument with the parent of the children you want returned.<br /> <br /> ===Returns===<br /> This function returns a ''table'' that contains a list of elements that the parent has.<br /> <br /> ==Example== <br /> In a blank map with nothing but players, using this function will return a table with all the players in it.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> --Get root element<br /> root = getRootElement()<br /> --Get ALL of root's children<br /> mytable = getElementChildren(root)<br /> &lt;/syntaxhighlight&gt;<br /> At a later point you could loop through all the elements and process thier contents any way you wish. Remember to make sure you have the CURRENT list of elements though. If you get the root element children, then wait a while for things to change, this list won't be up to date unless you use [[getElementChildren]] again.<br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementByID&diff=4497 2006-08-21T16:44:09Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function returns an element from the specified ID.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element getElementByID ( string id ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''id:''' The ID of the element as it appears in the XML file.<br /> <br /> ===Returns===<br /> Returns the element with the given ID, or ''false'' if no such element exists.<br /> <br /> ==Example== <br /> This example assigns the 'team1' element to redTeam after finding the element based on it's ID.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> -- Assuming an element with the id &quot;red&quot; exists (i.e. &lt;team1 id=&quot;red&quot;&gt;), get it's element<br /> redTeam = getElementByID ( &quot;red&quot; )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementByID&diff=4496 2006-08-21T16:43:46Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function returns an element from the specified ID.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element getElementByID ( string id ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''id:''' The ID of the element as it appears in the XML file.<br /> <br /> ===Returns===<br /> Returns the element with the given ID, or ''false'' if no such element exists.<br /> <br /> ==Example== <br /> This example assigns the 'team1' element to redTeam after finding the element based on it's ID.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> -- Assuming an element with the id &quot;red&quot; exists (i.e. &lt;team1 id=&quot;red&quot;&gt;), get it's element<br /> redTeam = getElementByID ( &quot;red&quot; )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{FunctionArea_Functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=GetElementByIndex&diff=4495 2006-08-21T16:42:53Z

<p>Vandalite: </p> <hr /> <div>[[Category:Incomplete]]<br /> <br /> __NOTOC__ <br /> This function returns an element of the specified type from index.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element getElementByIndex ( string type, int index ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''type:''' the type of the element to be returned. Examples include &quot;player&quot;, &quot;vehicle&quot;, or a custom type.<br /> *'''index:''' the element's index (0 for the first element, 1 for the second, etc).<br /> <br /> ===Returns===<br /> Returns the requested element, or false if it doesn't exist.<br /> <br /> ==Example== <br /> This example loops through each player and sends them a message.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> totalplayers = getPlayerCount () -- get the amount of players in the server<br /> local i = 0<br /> while ( i &lt; totalplayers ) do -- step through each player, from 0 to total<br /> pyr = getElementByIndex ( &quot;player&quot;, i ) -- get a player element from index and assign it to variable pyr<br /> outputChatBox ( &quot;Hello &quot; .. getPlayerName ( pyr ) .. &quot;!&quot;, pyr ) -- send player pyr a message<br /> i = i + 1<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element_functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=DestroyElement&diff=4432 2006-08-16T23:48:30Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function destroys an [[element]], and all the elements within it in the hierarchy (i.e. it's children and their children etc). [[player|Player]] elements cannot be destroyed using this function. A player can only be removed from the hierarchy when they quit or are kicked. The root element also cannot be destroyed, however, passing the root as an argument will wipe all elements from the map, except for the players, which will be placed as child elements just off the root node.<br /> <br /> Players are not the only elements that cannot be deleted. This list also includes remoteclinets, and console elements.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool destroyElement ( element elementToDestroy )<br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''elementToDestroy:''' The element you wish to destroy. <br /> <br /> ===Returns===<br /> Returns ''true'' if the element was destroyed successfully, ''false'' if either the element passed to it was invalid or it could not be destroyed for some other reason.<br /> <br /> ==Example== <br /> This example would destroy every element in the map, with the exception of players and the root element itself.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> -- Find the root element (the element that contains all others)<br /> root = getRootElement ()<br /> -- Destroy it and it's children.<br /> destroyElement ( root )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CloneElement&diff=4431 2006-08-16T23:47:52Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function clones (creates an exact copy of) an already existing element. The root node, and player elements cannot be cloned. If a player element is a child of an element that is cloned, it will be skipped, along with the elements that exist as a child to the player element.<br /> <br /> Players are not the only elements that cannot be cloned. This list also includes remoteclinets, and console elements.<br /> <br /> The cloned element will be placed on the element tree as a child of the same parent as the cloned element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element cloneElement ( element theElement, [ float xOffset = 0, float yOffset = 0, float zOffset = 0, bool cloneChildren = false ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element that you wish to clone.<br /> <br /> ===Optional Arguments===<br /> {{OptionalArg}}<br /> * '''xOffset''': A floating point number representing the offset from the cloned element's X coordinate on the map.<br /> * '''yOffset''': A floating point number representing the offset from the cloned element's Y coordinate on the map.<br /> * '''zOffset''': A floating point number representing the offset from the cloned element's Z coordinate on the map.<br /> * '''cloneChildren''': A boolean value representing whether or not the element's children will be cloned.<br /> <br /> ===Returns===<br /> Returns the handle of the new cloned element of the parent.<br /> <br /> ==Example== <br /> This example clones the vehicle a player is in.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> if ( command == &quot;clone&quot; ) then<br /> x, y, z = getElementPosition ( source ) -- get the position of the player<br /> clone = cloneElement ( getPlayerOccupiedVehicle ( source ), 5, 0, 0 ) -- create a clone of the player's vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CreateElement&diff=4430 2006-08-16T23:30:27Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> This function is used to create dummy elements in the element table, but do not have a counterpart within the San Andreas world. A common use for this function is for creating group or team elements.<br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element createElement ( string type, string name )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''type:''' This is the type of element being created. This value will be returned if getElementType is used on it.<br /> *'''name:''' This is the name of the element being created.<br /> <br /> ===Returns===<br /> Returns ''true'' if the element was successfully created. Returns ''false'' otherwise.<br /> <br /> ==Example==<br /> This example creates a squad element called 'Alpha', which will appear just off root on the element table:<br /> <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> alphahandle = createElement(&quot;Squad&quot;, &quot;Alpha&quot;)<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also== <br /> {{element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CloneElement&diff=4423 2006-08-16T16:59:41Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function clones (creates an exact copy of) an already existing element. The root node, and player elements cannot be cloned. If a player element is a child of an element that is cloned, it will be skipped, along with the elements that exist as a child to the player element.<br /> <br /> The cloned element will be placed on the element tree as a child of the same parent as the cloned element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element cloneElement ( element theElement, [ float xOffset = 0, float yOffset = 0, float zOffset = 0, bool cloneChildren = false ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element that you wish to clone.<br /> <br /> ===Optional Arguments===<br /> {{OptionalArg}}<br /> * '''xOffset''': A floating point number representing the offset from the cloned element's X coordinate on the map.<br /> * '''yOffset''': A floating point number representing the offset from the cloned element's Y coordinate on the map.<br /> * '''zOffset''': A floating point number representing the offset from the cloned element's Z coordinate on the map.<br /> * '''cloneChildren''': A boolean value representing whether or not the element's children will be cloned.<br /> <br /> ===Returns===<br /> Returns the handle of the new cloned element of the parent.<br /> <br /> ==Example== <br /> This example clones the vehicle a player is in.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> if ( command == &quot;clone&quot; ) then<br /> x, y, z = getElementPosition ( source ) -- get the position of the player<br /> clone = cloneElement ( getPlayerOccupiedVehicle ( source ), 5, 0, 0 ) -- create a clone of the player's vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=DestroyElement&diff=4422 2006-08-16T16:58:07Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function destroys an [[element]], and all the elements within it in the hierarchy (i.e. it's children and their children etc). [[player|Player]] elements cannot be destroyed using this function. A player can only be removed from the hierarchy when they quit or are kicked. The root element also cannot be destroyed, however, passing the root as an argument will wipe all elements from the map, except for the players, which will be placed as child elements just off the root node.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> bool destroyElement ( element elementToDestroy )<br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''elementToDestroy:''' The element you wish to destroy. <br /> <br /> ===Returns===<br /> Returns ''true'' if the element was destroyed successfully, ''false'' if either the element passed to it was invalid or it could not be destroyed for some other reason.<br /> <br /> ==Example== <br /> This example would destroy every element in the map, with the exception of players and the root element itself.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> -- Find the root element (the element that contains all others)<br /> root = getRootElement ()<br /> -- Destroy it and it's children.<br /> destroyElement ( root )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CreateElement&diff=4421 2006-08-16T16:41:00Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__<br /> This function is used to create dummy elements in the element table, but do not have a counterpart within the San Andreas world. A common use for this function is for creating group or team elements.<br /> <br /> ==Syntax==<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element createElement ( string type, string name )<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ===Required Arguments===<br /> *'''type:''' This is the type of element being created. This value will be returned if getElementType is used on it.<br /> *'''name:''' This is the name of the element being created.<br /> <br /> ==Example==<br /> This example creates a squad element called 'Alpha', which will appear just off root on the element table:<br /> <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> alphahandle = createElement(&quot;Squad&quot;, &quot;Alpha&quot;)<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also== <br /> {{element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=User_talk:Eai&diff=4402 2006-08-16T15:14:01Z

<p>Vandalite: Re: Note</p> <hr /> <div>== Hey Eai, first request of the day. ==<br /> I need a function header for createElement, and a good reason for its existence (I know about createvehicle, and its like, but this generic one mystifies me) [[User:Vandalite|Vandalite]] 21:43, 15 August 2006 (CDT)<br /> <br /> == Are player elements the only things that can't be wiped? ==<br /> <br /> Cause i'm pretty sure you can't touch the root node either. can you confirm this? Can you also confirm that passing root as an arg to destroyElement will wipe out group structures, and place all players as child elements just off root?<br /> <br /> And just as a side question, if i destroy an object with child player elements, will the player elements be set as child elements of the parent of the element that was just destroyed? or will they be shuffled to root?<br /> <br /> == CloneElement Questions ==<br /> <br /> 1) Why is it documented as a fake function?<br /> <br /> 2) I need verification that Players and the Root node elemebts cannot be cloned and that it will return false if attempted.<br /> <br /> 3) Make sure that if an element has children that are player elements, those player elements are not cloned.<br /> <br /> 4) What are the default values for the optional arguments used for this function. In particular, the cloneChildren argument.<br /> <br /> == Re: Note ==<br /> <br /> The root element should NOT be clonable. by definition, its the root, and there should only be one of them.<br /> <br /> I cannot imagine any situation where you'd want to clone everything on the server at once anyway.</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CloneElement&diff=4398 2006-08-16T15:11:30Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This function clones (creates an exact copy of) an already existing element. The root node, and player elements cannot be cloned. If a player element is a child of an element that is cloned, it will be skipped, along with the elements that exist as a child to the player element.<br /> <br /> The cloned element will be placed on the element tree as a child of the same parent as the cloned element.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element cloneElement ( element theElement, [ float xOffset = 0, float yOffset = 0, float zOffset = 0, bool cloneChildren = false ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element that you wish to clone.<br /> <br /> ===Optional Arguments===<br /> * '''xOffset''': A floating point number representing the offset from the cloned element's X coordinate on the map.<br /> * '''yOffset''': A floating point number representing the offset from the cloned element's Y coordinate on the map.<br /> * '''zOffset''': A floating point number representing the offset from the cloned element's Z coordinate on the map.<br /> * '''cloneChildren''': A boolean value representing whether or not the element's children will be cloned.<br /> <br /> ===Returns===<br /> Returns the handle of the new cloned element of the parent.<br /> <br /> ==Example== <br /> This example clones the vehicle a player is in.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> if ( command == &quot;clone&quot; ) then<br /> x, y, z = getElementPosition ( source ) -- get the position of the player<br /> clone = cloneElement ( getPlayerOccupiedVehicle ( source ), 5, 0, 0 ) -- create a clone of the player's vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CloneElement&diff=4385 2006-08-16T03:13:01Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This fake function clones (creates an exact copy of) an already existing element. The root node, and player elements cannot be cloned.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element cloneElement ( element theElement, [ float xPos, float yPos, float zPos, bool cloneChildren ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element that you wish to clone.<br /> <br /> ===Optional Arguments===<br /> * '''xPos''': A floating point number representing the X coordinate on the map.<br /> * '''yPos''': A floating point number representing the Y coordinate on the map.<br /> * '''zPos''': A floating point number representing the Z coordinate on the map.<br /> * '''cloneChildren''': A boolean value representing whether or not the element's children will be cloned.<br /> <br /> ===Returns===<br /> Returns the handle of the new cloned element of the parent.<br /> <br /> ==Example== <br /> This example clones the vehicle a player is in.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> if ( command == &quot;clone&quot; ) then<br /> x, y, z = getElementPosition ( source ) -- get the position of the player<br /> clone = cloneElement ( getPlayerOccupiedVehicle ( source ), x + 5, y, z ) -- create a clone of the player's vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element functions}}</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=User_talk:Eai&diff=4384 2006-08-16T03:06:11Z

<p>Vandalite: CloneElement Questions</p> <hr /> <div>== Hey Eai, first request of the day. ==<br /> I need a function header for createElement, and a good reason for its existence (I know about createvehicle, and its like, but this generic one mystifies me) [[User:Vandalite|Vandalite]] 21:43, 15 August 2006 (CDT)<br /> <br /> == Are player elements the only things that can't be wiped? ==<br /> <br /> Cause i'm pretty sure you can't touch the root node either. can you confirm this? Can you also confirm that passing root as an arg to destroyElement will wipe out group structures, and place all players as child elements just off root?<br /> <br /> And just as a side question, if i destroy an object with child player elements, will the player elements be set as child elements of the parent of the element that was just destroyed? or will they be shuffled to root?<br /> <br /> == CloneElement Questions ==<br /> <br /> 1) Why is it documented as a fake function?<br /> <br /> 2) I need verification that Players and the Root node elemebts cannot be cloned and that it will return false if attempted.<br /> <br /> 3) Make sure that if an element has children that are player elements, those player elements are not cloned.<br /> <br /> 4) What are the default values for the optional arguments used for this function. In particular, the cloneChildren argument.</div>

Vandalite https://wiki.multitheftauto.com/index.php?title=CloneElement&diff=4383 2006-08-16T03:05:37Z

<p>Vandalite: </p> <hr /> <div>__NOTOC__ <br /> This fake function clones (creates an exact copy of) an already existing element. The root node, and player elements cannot be cloned.<br /> <br /> ==Syntax== <br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> element cloneElement ( element theElement, [ float xPos, float yPos, float zPos, bool cloneChildren ] ) <br /> &lt;/syntaxhighlight&gt; <br /> <br /> ===Required Arguments=== <br /> *'''theElement:''' The element that you wish to clone.<br /> <br /> ===Optional Arguments===<br /> * '''xPos''': A floating point number representing the X coordinate on the map.<br /> * '''yPos''': A floating point number representing the Y coordinate on the map.<br /> * '''zPos''': A floating point number representing the Z coordinate on the map.<br /> * '''cloneChildren''': A boolean value representing whether or not the element's children will be cloned.<br /> <br /> ===Returns===<br /> Returns the handle of the new cloned element of the parent.<br /> <br /> ==Example== <br /> This example clones the vehicle a player is in.<br /> &lt;syntaxhighlight lang=&quot;lua&quot;&gt;<br /> if ( command == &quot;clone&quot; ) then<br /> x, y, z = getElementPosition ( source ) -- get the position of the player<br /> clone = cloneElement ( getPlayerOccupiedVehicle ( source ), x + 5, y, z ) -- create a clone of the player's vehicle<br /> end<br /> &lt;/syntaxhighlight&gt;<br /> <br /> ==See Also==<br /> {{Element Functions}}</div>

Vandalite