Multi Theft Auto: Wiki - User contributions [en]

OnClientResourceStart

2007-09-05T08:50:15Z

The Smoo:

[[Category:Incomplete Event]]

__NOTOC__
This event is blahblah and is used for blahblah.

==Syntax==
<syntaxhighlight lang="lua">
void onClientResourceStart ( pointer name )
</syntaxhighlight>

==Example==
This example does...
<syntaxhighlight lang="lua">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

GetAccountName

2007-08-25T01:43:07Z

The Smoo:

{{Server function}}
__NOTOC__
This function retrieves the name of an account.

==Syntax==
<syntaxhighlight lang="lua">
string getAccountName ( account theAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to get the name of

===Returns===
Returns a string containing the account's name, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==

<syntaxhighlight lang="lua">
function test_onClientLogin ( previous_account, current_account, auto-login )
outputConsole(getAccountName(previous_account).." Logged into "..getAccountName(current_account))
end

addEventHandler("onClientLogin",getRootElement(),test_onClientLogin)
</syntaxhighlight>

==See Also==
{{Account_functions}}

RemoveAccount

2007-08-25T01:42:33Z

The Smoo:

{{Server function}}
__NOTOC__
This function is used to delete existing player accounts.

==Syntax==
<syntaxhighlight lang="lua">
bool removeAccount ( account theAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to remove

===Returns===
Returns ''true'' if account was successfully removed, ''false'' if the account does not exist.

==Example==

This example does...

<syntaxhighlight lang="lua">
function onCmdRemove(playerSource,commandName,playerName)
-- Lets make sure they didn't put nothing for the playername
if playerName ~= nil then
-- Lets get the player from the nick provided
local targetPlayer = getPlayerFromNick(playerName)
-- Checking if the player actually exists
if targetPlayer ~= nil then
-- grab the accounts
local sourceAccount = getClientAccount(playerSource)
local targetAccount = getClientAccount(targetPlayer)
-- Now check to see if the player has greater priviledges (or levels)
if getAccountLevel(sourceAccount) > getAccountLevel(targetAccount) then
removeAccount(targetAccount)
outputChatBox(getClientName(playerSource).." removed "..playerName.."'s account")
else outputChatBox("You don't have authority to remove "..playerName.."'s account",playerSource) end
else outputChatBox("There is no player by the name of "..playerName,playerSource) end
else outputChatBox("USAGE: /remvoe [playername]",playerSource) end
end

addCommandHandler("remove",onCmdRemove)
</syntaxhighlight>

==See Also==

{{Account_functions}}

RemoveAccount

2007-08-25T01:35:34Z

The Smoo:

RemoveAccount

2007-08-25T01:27:40Z

The Smoo:

GetAccountName

2007-08-25T01:18:35Z

The Smoo:

EngineImportCOL

2007-08-24T10:01:19Z

The Smoo:

{{Client function}}
__NOTOC__
This function imports a RenderWare Collision into the model identified by the model id. This function does not replace the collisions of all models of this type in-game.

To ensure proper replacement, please do not use this function for vehicles.

==Syntax==
<syntaxhighlight lang="lua">
bool engineImportCOL ( col, number model_id )
</syntaxhighlight>

===Required Arguments===
*'''col:''' The COL that was loaded with [[engineLoadCOL]]
*'''model_id:''' The model id to import the COL into

===Returns===
Returns ''true'' if the function executed succesfully, ''false'' otherwise.

==Example==
* See [[engineReplaceVehicleModel]] for a vehicle replacement example
* See [[engineReplaceObjectModel]] for an object replacement example

==See Also==
{{Engine_functions}}

Element

2007-08-22T06:29:27Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/TXD|TXDs]]
* [[Element/DFF|DFFs]]
* [[Element/XML|XMLNodes]]
* [[Element/Client|Clients]]
* [[Element/Spawnpoint|Spawnpoints]]
* [[Element/Textdisplay|Text Display's]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element

2007-08-22T06:28:50Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/TXD|TXDs]]
* [[Element/DFF|DFFs]]
* [[Element/XML|XMLNodes]]
* [[Element/Client|Clients]]
* [[Element/Spawnpoint|Spawnpoints]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

GetAccountClient

2007-08-22T06:24:36Z

The Smoo:

{{Server function}}
__NOTOC__
This function returns the client that is currently using a specified account, i.e. is logged into it. Only one client can use an account at a time.
==Syntax==
<syntaxhighlight lang="lua">
client getAccountClient ( account theAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to get the client of.

===Returns===
Returns a [[client]] element if the account is currently in use, ''false'' otherwise.

==Example==
This example checks if the user attached to an account is a player, and if so if they're alive.
<syntaxhighlight lang="lua">
function isAccountUserAlive ( theAccount )
local theClient = getAccountClient ( theAccount ) -- get the client attached to the account
if ( getElementType ( theClient ) == "player" ) then -- see if it's a player (rather than an admin for example)
if ( not isPlayerDead ( theClient ) ) then -- if the player's health is greater than 0
return true
end
end
return false
end
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountClient

2007-08-22T06:24:16Z

The Smoo:

{{Server function}}
__NOTOC__
This function returns the client that is currently using a specified account, i.e. is logged into it. Only one client can use an account at a time.
==Syntax==
<syntaxhighlight lang="lua">
client getAccountClient ( account theAccount )
</syntaxhighlight>

===Required Arguments===
*'''theAccount:''' The account you wish to get the client of.

===Returns===
Returns a [[Element/Client]] element if the account is currently in use, ''false'' otherwise.

==Example==
This example checks if the user attached to an account is a player, and if so if they're alive.
<syntaxhighlight lang="lua">
function isAccountUserAlive ( theAccount )
local theClient = getAccountClient ( theAccount ) -- get the client attached to the account
if ( getElementType ( theClient ) == "player" ) then -- see if it's a player (rather than an admin for example)
if ( not isPlayerDead ( theClient ) ) then -- if the player's health is greater than 0
return true
end
end
return false
end
</syntaxhighlight>

==See Also==
{{Account_functions}}

Element

2007-08-22T06:21:30Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/TXD|TXDs]]
* [[Element/DFF|DFFs]]
* [[Element/XML|XMLNodes]]
* [[Element/Client|Clients]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element/XML

2007-08-22T06:19:51Z

The Smoo: New page: __NOTOC__ The xmlnode class represents xmlnodes controlled by either server or client side scripting. This class is created when a client or server script creates it and it is destroyed in...

__NOTOC__
The xmlnode class represents xmlnodes controlled by either server or client side scripting. This class is created when a client or server script creates it and it is destroyed in the same way.

The element type of this class is '''"xmlnode"'''.

==Related scripting functions==
===Client===
{{Client_xml_functions}}
===Server===
{{XML functions}}

Element

2007-08-22T06:17:51Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/Remote client|Remote clients]]
* [[Element/Server console|Server console]]
* [[Element/TXD|TXDs]]
* [[Element/DFF|DFFs]]
* [[Element/XML|XMLNodes]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element

2007-08-22T06:17:27Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/Remote client|Remote clients]]
* [[Element/Server console|Server console]]
* [[Element/TXD|TXDs]]
* [[Element/DFF|DFFs]]
* [[Element/XML/XMLs]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element

2007-08-22T06:17:13Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/Remote client|Remote clients]]
* [[Element/Server console|Server console]]
* [[Element/TXD|TXDs]]
* [[Element/DFF|DFFs]]
* [[Element/XML/XML]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element/DFF

2007-08-22T06:13:32Z

The Smoo: New page: __NOTOC__ The dff class represents a Renderware Model File (DFF) controlled via client side scripting. This class is created when the client side scripts creates it and destroyed the same ...

__NOTOC__
The dff class represents a Renderware Model File (DFF) controlled via client side scripting. This class is created when the client side scripts creates it and destroyed the same way.

The element type of this class is '''"dff"'''.

==Related scripting functions==
===Client===
{{Engine_functions}}

Element

2007-08-22T06:11:09Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/Remote client|Remote clients]]
* [[Element/Server console|Server console]]
* [[Element/TXD|TXDs]]
* [[Element/DFF|DFFs]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element/TXD

2007-08-22T06:10:24Z

The Smoo: New page: __NOTOC__ The txd class represents a texture controlled by the client. This class is created when a client side script creates it and is destroyed in the same way. The element type of thi...

__NOTOC__
The txd class represents a texture controlled by the client. This class is created when a client side script creates it and is destroyed in the same way.

The element type of this class is '''"txd"'''.

==Related scripting functions==
===Client===
{{Engine_functions}}

Element

2007-08-22T06:08:33Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/Remote client|Remote clients]]
* [[Element/Server console|Server console]]
* [[Element/TXD|TXDs]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element

2007-08-22T06:05:45Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/Remote client|Remote clients]]
* [[Element/Server console|Server console]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element/Team

2007-08-22T06:05:10Z

The Smoo: New page: __NOTOC__ The team class represents teams controlled by the server. This class is created created/destroyed using scripting functions on the server. The element type of this class is '''"...

__NOTOC__
The team class represents teams controlled by the server. This class is created created/destroyed using scripting functions on the server.

The element type of this class is '''"team"'''.

==Related scripting functions==
===Client===
{{Client_team_functions}}
===Server===
{{Team functions}}

Element

2007-08-22T06:01:28Z

The Smoo:

{{Needs_Checking|Need to make sure all elements are listed --[[User:Erorr404|Erorr404]] 21:44, 8 December 2006 (CST)}}

An element is a generic class that represents almost all in-game items. These include:
* [[Element/Player|Players]]
* [[Element/Vehicle|Vehicles]]
* [[Element/Object|Objects]]
* [[Element/Pickup|Pickups]]
* [[Element/Marker|Markers]]
* [[Element/Collision shape|Collision shapes]]
* [[Element/Blip|Blips]]
* [[Element/Radar area|Radar areas]]
* [[Element/Team|Teams]]
* [[Element/Remote client|Remote clients]]
* [[Element/Server console|Server console]]
* [[Element/Col Shapes|Col Shapes]]

These are all stored internally in a [[Element tree|"tree" structure]], as such every element has a parent element, be in the ''root'' element, ''map'' or another element. This is purely for declaring the scope of function calls.

There are various functions for manipulating the layout of this element tree.

Element/Radar area

2007-08-22T05:59:05Z

The Smoo: New page: __NOTOC__ The radar area class represents radar area's controlled by both the server and the client. This class is created when a radar area is created and destroyed when it is destroyed v...

__NOTOC__
The radar area class represents radar area's controlled by both the server and the client. This class is created when a radar area is created and destroyed when it is destroyed via a script or a player disconnects.

The element type of this class is '''"radararea"'''.

==Related scripting functions==
===Client===
{{Client_radar-area_functions}}
===Server===
{{Radar area functions}}

Element/Blip

2007-08-22T05:55:49Z

The Smoo:

__NOTOC__
The blip class represents radar blips that appear on a clients radar. This class can be both created an destroyed via scripting and disconnection.

The element type of this class is '''"blip"'''.

==Related scripting functions==
===Client===
{{Client_blip_functions}}
===Server===
{{Blip_functions}}
==Blip Icon References==
{{Blip Icons}}

Element/Blip

2007-08-22T05:55:04Z

The Smoo:

__NOTOC__
The blip class represents radar blips that appear on a clients radar. This class can be both created an destroyed via scripting and disconnection.

The element type of this class is '''"blip"'''.

==Related scripting functions==
{{Client_blip_functions}}
==Blip Icon References==
{{Blip Icons}}

Element/Blip

2007-08-22T05:54:14Z

The Smoo: New page: __NOTOC__ The blip class represents radar blips that appear on a clients radar. This class can be both created an destroyed via scripting and disconnection. The element type of this class...

__NOTOC__
The blip class represents radar blips that appear on a clients radar. This class can be both created an destroyed via scripting and disconnection.

The element type of this class is '''"blip"'''.

==Related scripting functions==
{{Blip Functions}}
==Blip Icon References==
{{Blip Icons}}