Multi Theft Auto: Wiki - User contributions [en]

Resource:Maplimits

2007-12-06T17:19:47Z

Black Dragon: New page: __NOTOC__ Map Limits is a resource that allows defining points in a .map file to border a map. A player outside the border area will lose health until he dies or returns to the game area. ...

__NOTOC__
Map Limits is a resource that allows defining points in a .map file to border a map. A player outside the border area will lose health until he dies or returns to the game area.

==Usage==
Syntax:
<syntaxhighlight lang="lua">
<maplimit>
<point x="" y="" />
<point x="" y="" />
<point x="" y="" />
</maplimit>
</syntaxhighlight>

When using maplimits in ones map, at least three points must be made. 
 
Note that the sequence of points matters. For example, this would create a square shaped border:
<syntaxhighlight lang="lua">
<point x="0" y="0" />
<point x="1" y="0" />
<point x="1" y="1" />
<point x="0" y="1" />
</syntaxhighlight>
 
While this would create two triangles:
<syntaxhighlight lang="lua">
<point x="0" y="0" />
<point x="1" y="1" />
<point x="0" y="1" />
<point x="1" y="0" />
</syntaxhighlight>

Resource:CDM

2007-12-06T17:10:24Z

Black Dragon:

__NOTOC__
Classic DeathMatch is a gamemode that imitates the gameplay of MTA:VC. Before spawning the player is given the choice to select a class/team, and after spawning he's allowed to do whatever he wants, unless the map loaded limits him or instructs him otherwise.

==Ingame keys==
Left/Right - used to scroll through teams/classes while in spawnscreen. 
Enter - used to confirm a team/class selection from the spawnscreen. 
I - used to show vehicles that are close to the player. 

==Usage==
Syntax:
<syntaxhighlight lang="lua">
<team name="" red="" green="" blue="">
<camera lookX="" lookY="" lookZ="" posX="" posY="" posZ=""/>
<weapon model="" ammo=""/>
<skin model=""/>
<spawnpoint posX="" posY="" posZ="" rot=""/>
</team>
</syntaxhighlight>

When making a CDM map, one must define at least two teams, and each team must have a name, and it is optional to also give the teams colors (if none specified, defaults to white). 
Inside each team there are a few definable things-
* Camera - this is used for the camera on the spawnscreen when the team is selected. lookX/Y/Z refer to the position the camera would 'look' at, posX/Y/Z refers to the cameras position. Not specifying a camera or specifying it wrong would result in defaulting the camera to 0, 0, 0, 0, 0, 0. Note: only the first <camera> data in each team would be read.
* Weapons - this is used as to give players weapons that their team/class receives on spawn. model refers to the weapon ID, ammo refers to how much ammo of the weapon will the player spawn with. While not specifying weapons is alright, specifying them wrong would result in an error and the map would not load. You can specify as many weapons as you wish.
* Skins - this is used for players spawning skins. The skin they will spawn with is picked randomly from the list of skins in the current team. model refers to the skin ID. While not specifying skins would result in all players of this teams spawning with the CJ skin, specifying them wrong would result in an error and the map would not load. You can specify as many skins as you wish.
* Spawnpoints - this is to determinate where the players would spawn. The spawnpoint the player would spawn at is randomly picked from the list of spawnpoints in the current team. posX/Y/Z refers to the spawnpoints position, rot refers to the spawning rotation. You must specify at least one spawnpoint per team, as if you specify less than one or specify a spawnpoint wrong will result in an error and the map would not load.

Resource:CTF

2007-12-06T17:10:16Z

Black Dragon: New page: __NOTOC__ Capture the Flag is a team based gamemode. Players capture enemy teams flags and return them to their own to gain points. The team with the most points by the end of the round wi...

__NOTOC__
Capture the Flag is a team based gamemode. Players capture enemy teams flags and return them to their own to gain points. The team with the most points by the end of the round wins.

==Ingame keys==
Left/Right - used to scroll through teams while in spawnscreen. 
Enter - used to confirm a team selection from the spawnscreen. 
 
Note: spawnscreen might be disabled on some maps. 

==Usage==
Syntax:
<syntaxhighlight lang="lua">
<team name="" colorR="" colorG="" colorB="">
<flag name="" posX="" posY="" posZ="" />
<spawnpoint posX="" posY="" posZ="" rot="" model="" />
</team>
</syntaxhighlight>

When making a CTF map, one must define at least two teams. 
Inside each team there are a few definable things-
* Flags - used to define a flag. Name refers to the flags name, and posX/Y/Z refers to the flags position. Each team must have at least one flag.
* * Spawnpoints - this is to determinate where the players would spawn. The spawnpoint the player would spawn at is randomly picked from the list of spawnpoints in the current team. posX/Y/Z refers to the spawnpoints position, rot refers to the spawning rotation. You must specify at least one spawnpoint per team.

==Settings==
Syntax:
<syntaxhighlight lang="lua"><settings respawnTime="" roundTime="" spawnScreen="" blips=""/></syntaxhighlight>

* respawnTime refers to the amount of milliseconds a player has to wait before spawning after being killed. Default is 4500.
* roundTime refers to the amount of milliseconds a round lasts. Default is 600000.
* spawnScreen - if the value is "on", spawnscreen is on. Otherwise, not spawnscreen would appear.
* blips - if the value is "all", all player blips and flag blips would be shown; if it's "team", only the players teams player blips and flag blips would be shown; otherwise, CTF won't show blips.

User:Black Dragon

2007-10-04T14:19:35Z

Black Dragon:

===Stuff===

[[User:Black_Dragon/cdm|CDM]] [''cdm''] 
[[User:Black_Dragon/ctf|CTF]] [''ctf''] 
[[User:Black_Dragon/maplimits|Map Limits]] [''maplimits''] 

===Misc.===
[[User:Black_Dragon/hay|Hay - the song]]

User:Black Dragon

2007-10-04T14:19:19Z

Black Dragon:

Resource:CDM

2007-09-28T13:18:02Z

Black Dragon: New page: __NOTOC__ Classic DeathMatch is a gamemode that imitates the gameplay of MTA:VC. Before spawning the player is given the choice to select a class/team, and after spawning he's allowed to d...

__NOTOC__
Classic DeathMatch is a gamemode that imitates the gameplay of MTA:VC. Before spawning the player is given the choice to select a class/team, and after spawning he's allowed to do whatever he wants, unless the map loaded limits him or instructs him otherwise.

==Ingame keys==
Left/Right - used to scroll through teams/classes while in spawnscreen. 
Enter - used to confirm a team/class selection from the spawnscreen. 
I - used to show vehicles that are close to the player. 

==Usage==
Syntax:
<syntaxhighlight lang="lua">
<team name="" red="" green="" blue="">
<camera lookX="" lookY="" lookZ="" posX="" posY="" posZ=""/>
<weapon model="" ammo=""/>
<skin model=""/>
<spawnpoint posX="" posY="" posZ="" rot=""/>
</team>
</syntaxhighlight>

When making a CDM map, one must define at least two teams, and each team must have a name, and it is optional to also give the teams colors (if none specified, defaults to white).
Inside each team there are a few definable things-
* Camera - this is used for the camera on the spawnscreen when the team is selected. lookX/Y/Z refer to the position the camera would 'look' at, posX/Y/Z refers to the cameras position. Not specifying a camera or specifying it wrong would result in defaulting the camera to 0, 0, 0, 0, 0, 0. Note: only the first <camera> data in each team would be read.
* Weapons - this is used as to give players weapons that their team/class receives on spawn. model refers to the weapon ID, ammo refers to how much ammo of the weapon will the player spawn with. While not specifying weapons is alright, specifying them wrong would result in an error and the map would not load. You can specify as many weapons as you wish.
* Skins - this is used for players spawning skins. The skin they will spawn with is picked randomly from the list of skins in the current team. model refers to the skin ID. While not specifying skins would result in all players of this teams spawning with the CJ skin, specifying them wrong would result in an error and the map would not load. You can specify as many skins as you wish.
* Spawnpoints - this is to determinate where the players would spawn. The spawnpoint the player would spawn at is randomly picked from the list of spawnpoints in the current team. posX/Y/Z refers to the spawnpoints position, rot refers to the spawning rotation. You must specify at least one spawnpoint per team, as if you specify less than one or specify a spawnpoint wrong will result in an error and the map would not load.

User:Black Dragon

2007-09-28T12:47:18Z

Black Dragon: New page: ===Stuff=== CDM [''cdm''] CTF [''ctf''] Map Limits [''maplimits'']

===Stuff===

[[User:Black_Dragon/cdm|CDM]] [''cdm''] 
[[User:Black_Dragon/ctf|CTF]] [''ctf''] 
[[User:Black_Dragon/maplimits|Map Limits]] [''maplimits'']

GetVehicleLandingGearDown

2007-08-11T11:33:09Z

Black Dragon:

__NOTOC__
{{server client function}}
This function is used to check whether a vehicles' landing gear is down or not. Only planes can be used with this function.

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleLandingGearDown ( vehicle thevehicle )
</syntaxhighlight>

===Required Arguments===
*'''thevehicle:''' The vehicle that you wish to check its' landing gear state.

===Returns===
Returns ''true'' if landing gear is down, ''false'' if the landing gear is up. 
Returns ''nil'' if the vehicle has no landing gear, or is invalid.

==Example==
This function tells you to pull up if you're flying low in a hydra with your landing gear up.
<syntaxhighlight lang="lua">
function checkGear( player )
vehicle = getPlayerOccupiedVehicle( player ) --Get the players vehicle
if ( ( getVehicleID(vehicle) == 520 ) and ( getVehicleLandingGearDown( vehicle ) == false ) ) then --if the vehicle is a hydra, and the landing gear is up
outputChatBox( "Pull up!", player ) --tell the player to pull up.
end
end
</syntaxhighlight>

==See Also==
{{Vehicle functions}}
[[Category:Incomplete]]

GetVehicleIDFromName

2007-08-11T11:32:22Z

Black Dragon:

__NOTOC__
{{server client function}}
This function retrieves the ID of a vehicle as an integer value from its name.

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleIDFromName ( string name )
</syntaxhighlight>

===Required Arguments===
*'''name:''' A [[string]] containing the name of the vehicle.

===Returns===
Returns an [[int]] if the name exists, ''false'' otherwise.

==Example==
This will allow the player to create a vehicle by name and it's ID will be displayed in the chatbox when the vehicle is spawned.
<syntaxhighlight lang="lua">
function createvehiclecommand ( player, commandName, carname )
--This function is triggered by the text "spawnvehicle" in the console.
--The player must also specify the added varible carname to specify
--what car they wish to spawn.
carid = getVehicleIDFromName ( carname )
--Get the ID of the car the player asked for and store it to the
--varible 'carid'
local x, y, z = getElementPosition ( player )
--Get the position of the player to spawn the car near this location
if carid == false then
outputChatBox ( "That is not a valid car name" )
else
createVehicle ( carid, x + 5, y, z )
--Spawn the car using it's ID. Spawn it at x + 5 from the player so it doesn't crush him
outputChatBox ( "A vehicle with an ID of "..carid.." was created!" )
end
--If the entered car name returns no car ID, the string will be empty and false will be returned.
--If the string does have any value, we create the car and announce the car ID in the chatbox,
--because a car did exist under the given car name.
end
addCommandHandler ( "spawnvehicle", "createvehiclecommand" )
</syntaxhighlight>

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

GetVehicleID

2007-08-11T11:31:42Z

Black Dragon:

__NOTOC__
{{server client function}}
This function retrieves the ID of a vehicle as an integer value.

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleID ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you want to get the ID of.

===Returns===
Returns an integer containing the requested vehicle's ID, or false if the vehicle passed to the function is invalid.

==Example==
<syntaxhighlight lang="lua">
function planeEnter ( theVehicle, seat, jacked ) --when someone enters a vehicle
id = getVehicleID ( theVehicle ) -- get the ID of the vehicle
if id == 519 or 577 then --if theVehicle is one of these two planes
vehiclename = getVehicleName ( theVehicle ) -- define the vehicle name
outputChatBox ( "Someone stole a "..vehiclename.."!" ) -- announce that someone stole the plane
end
end
-- add the event to the event handler
addEventHandler ( "onPlayerEnterVehicle", getRootElement(), planeEnter )
</syntaxhighlight>

==See Also==
{{IDs}}

{{Vehicle_functions}}

GetResourceConfig

2007-08-11T11:30:36Z

Black Dragon:

__NOTOC__
{{server client function}}
This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[meta file]].

==Syntax==
<syntaxhighlight lang="lua">
xmlnode getResourceConfig ( [resource theResource = getThisResource()], string filename )
</syntaxhighlight>

===Required Arguments===
*'''filename:''' The exact file name of the configuration file. (e.g. "file.xml" )

===Optional Arguments===
*'''theResource:''' The resource from which the function calls the configuration file

===Returns===
Returns the root node of the specified configuration file. If the file is corrupted, not defined in the meta file or doesn't exist, returns false.

==Example==
In the example
<syntaxhighlight lang="lua">
function resourceStart ( resourcename ) --When the resource is started
if ( resourcename == getThisResource () ) then --if the resource is this one
node = getResourceConfig( resourcename, "file.xml" ) --get the configuration file
local subNode = xmlFindSubNode( node, "group", 1 ) --get a subnode in it
outputChatBox( xmlNodeGetAttribute( node, "attr" ) ) --output its' the attributes value to chatbox.
end
end
addEventHandler ( "onResourceStart", getRootElement(), resourceStart )
</syntaxhighlight>

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

GetResourceLastStartTime

2007-08-11T11:30:04Z

Black Dragon:

__NOTOC__
{{server function}}
Used to check the last starting time and date of a function

==Syntax==
<syntaxhighlight lang="lua">string getResourceLastStartTime ( resource theResource )</syntaxhighlight>

===Required Arguments===
*'''theResource:''' The resource of which you'd like to check the last starting time and date.

===Returns===
Returns a string with the time and date, or false if the resource does not exist.

==Example==
This function outputs to chatbox when the current resource was started.
<syntaxhighlight lang="lua">
function whenStarted()
local startTime = getResourceLastStartTime ( getThisResource() ) --Get the time and date
outputChatBox( "This resource was started on: " .. startTime ) --tell everybody when the current resource was started.
end
</syntaxhighlight>

==See Also==
{{Resource functions}}

GetResourceInfo

2007-08-11T11:29:54Z

Black Dragon:

{{Needs_Checking|may return a string, bool or nil (?) --[[User:Jbeta|jbeta]]}}
__NOTOC__
{{server function}}
This function retrieves the value of any attribute in a resource info tag.

==Syntax==
<syntaxhighlight lang="lua">
string getResourceInfo ( resource theResource, string attribute )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource we are getting the info from.
*'''attribute:''' the name of the attribute we want info about.

===Returns===
Returns a ''string'' with the attribute value if it exists, ''false'' otherwise.

==Example==
This function tells the server who's the author who made the currently running resource.
<syntaxhighlight lang="lua">
function outputAuthor()
author = getResourceInfo ( getThisResource(), "author" ) --Get the authors name
if author then --if it exists
outputChatBox( author .. " made this script." ) --tell the world his name
else --if it doesn't
outputChatBox( "I've no idea who made this script." ) --apologize.
end
end
</syntaxhighlight>

==See Also==
{{Resource_functions}}

GetRandomPlayer

2007-08-11T11:27:47Z

Black Dragon:

__NOTOC__
{{server function}}
This function returns a random [[player]]. It is useful for assigning objectives to random players in a Manhunt mode, for example.

==Syntax==
<syntaxhighlight lang="lua">player getRandomPlayer ( )</syntaxhighlight>

===Required Arguments===
''This function has no arguments.''

==Example==
This code outputs a random's player name.
<syntaxhighlight lang="lua">
randomPlayer = getRandomPlayer ( )
outputChatBox ( getClientName ( randomPlayer ).." is now the fugitive!" )
</syntaxhighlight>

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

GetRadarAreaSize

2007-08-11T11:27:34Z

Black Dragon:

__NOTOC__
{{server function}}
Used for getting the X and Y size of an existing radar area.

==Syntax==
<syntaxhighlight lang="lua">
float float getRadarAreaSize ( radararea theRadararea )
</syntaxhighlight>

===Required Arguments===
*'''theRadararea:''' The radararea element whose size you wish to get.

===Returns===
Returns two ''floats'' indicating the X and Y length of the radar area respectively, ''false'' if the radar area doesn't exist.

==Example==
The following example looks for radar areas whose size is smaller than 100 by 100:
<syntaxhighlight lang="lua">
radarareas = getElementsByType ( "radararea" ) -- get a tabele of radararea elements
for k,v in ipairs(radarareas) do -- use a generic for loop to step through each of the elements
local sizeX, sizeY = getRadarAreaSize ( v ) -- get the size of the radar area
if ( sizeX < 100 and sizeY < 100 ) then -- check if it's smaller than 100 by 100
outputChatBox ( "A small radar area was found!" )
end
end
</syntaxhighlight>
This example creates a radar area and stores it's size in variables x and y:
<syntaxhighlight lang="lua">
greenArea = createRadarArea ( 1024, 1024, 50, 120, 0, 220, 0, 85 )
local x, y = getRadarAreaSize ( greenArea )
</syntaxhighlight>

==See Also==
{{Radar area_functions}}

GetRadarAreaColor

2007-08-11T11:27:08Z

Black Dragon:

__NOTOC__
{{server function}}
This function can be used to retrieve the current color of a Radar Area.

==Syntax==
<syntaxhighlight lang="lua">
int int int int getRadarAreaColor ( radararea theRadararea )
</syntaxhighlight>

===Required Arguments===
*'''theRadararea:''' The radar area you wish to retrieve the colour of

===Returns===
Returns four integers in RGBA format (''red'', ''green'', ''blue'', ''alpha''), with a maximum value of 255 for each. Alpha decides transparancy where 255 is opaque and 0 is transparent. Returns ''false'' if the radararea is invalid.

==Example==
This example checks the color of a radararea defined as 'area' and announces if it is ballas or grove street.
<syntaxhighlight lang="lua">
local r,g,b,a = getRadarAreaColor ( area ) --get the color of 'area' and define it as 'r', 'g', 'b' and 'a'
if g == 255 then --if the radar area is fully green
outputChatBox ( "This is Grove Street turf!" ) --announce it as grove street area
elseif r == 255 then --if it is fully red however
outputChatBox ( "This is Ballas turf!" ) --announce it as ballas area
end
</syntaxhighlight>

==See Also==
{{Radar area functions}}

GetPlayerWantedLevel

2007-08-11T11:26:16Z

Black Dragon:

__NOTOC__
{{server function}}
This function gets a player's current wanted level. The wanted level is indicated by the amount of stars a player has on the [[HUD]].

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

===Required Arguments===
*'''thePlayer:''' The player whose wanted level you wish to get

===Returns===
Returns an ''int'' from 0 to 6 representing the player's wanted level, ''false'' if the player does not exist.

==Example==
This example finds which players in the server have a wanted level:
<syntaxhighlight lang="lua">
local players = getElementsByType ( "player" ) -- get a table of all the players in the server
for theKey,thePlayer in ipairs(players) do -- use a generic for loop to step through each player
local level = getPlayerWantedLevel ( thePlayer ) -- get the wanted level of the player
if ( level > 0 ) then -- if the player has any stars, announce it in the chat:
outputChatBox ( getClientName ( thePlayer ) .. " has a wanted level of " .. level .. " stars!" )
end
end
</syntaxhighlight>

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

GetVehicleLandingGearDown

2007-07-30T14:03:15Z

Black Dragon: /* Example */

__NOTOC__
This function is used to check whether a vehicles' landing gear is down or not.

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleLandingGearDown ( vehicle thevehicle )
</syntaxhighlight>

===Required Arguments===
*'''thevehicle:''' The vehicle that you wish to check its' landing gear state.

===Returns===
Returns ''true'' if landing gear is down, ''false'' if the landing gear is up. 
Returns ''nil'' if the vehicle has no landing gear, or is invalid.

==Example==
This function tells you to pull up if you're flying low in a hydra with your landing gear up.
<syntaxhighlight lang="lua">
function checkGear( player )
vehicle = getPlayerOccupiedVehicle( player ) --Get the players vehicle
if ( ( getVehicleID(vehicle) == 520 ) and ( getVehicleLandingGearDown( vehicle ) == false ) ) then --if the vehicle is a hydra, and the landing gear is up
outputChatBox( "Pull up!", player ) --tell the player to pull up.
end
end
</syntaxhighlight>

==See Also==

{{Vehicle functions}}
[[Category:Incomplete]]

GetVehicleIDFromName

2007-07-30T13:49:21Z

Black Dragon: /* Example */

__NOTOC__
This function retrieves the ID of a vehicle as an integer value from its name.

==Syntax==
<syntaxhighlight lang="lua">
int getVehicleIDFromName ( string name )
</syntaxhighlight>

===Required Arguments===
*'''name:''' A [[string]] containing the name of the vehicle.

===Returns===
Returns an [[int]] if the name exists, ''false'' otherwise.

==Example==
This will allow the player to create a vehicle by name and it's ID will be displayed in the chatbox when the vehicle is spawned.
<syntaxhighlight lang="lua">
function createvehiclecommand ( player, commandName, carname )
--This function is triggered by the text "spawnvehicle" in the console.
--The player must also specify the added varible carname to specify
--what car they wish to spawn.
carid = getVehicleIDFromName ( carname )
--Get the ID of the car the player asked for and store it to the
--varible 'carid'
local x, y, z = getElementPosition ( player )
--Get the position of the player to spawn the car near this location
if carid == false then
outputChatBox ( "That is not a valid car name" )
else
createVehicle ( carid, x + 5, y, z )
--Spawn the car using it's ID. Spawn it at x + 5 from the player so it doesn't crush him
outputChatBox ( "A vehicle with an ID of "..carid.." was created!" )
end
--If the entered car name returns no car ID, the string will be empty and false will be returned.
--If the string does have any value, we create the car and announce the car ID in the chatbox,
--because a car did exist under the given car name.
end
addCommandHandler ( "spawnvehicle", "createvehiclecommand" )
</syntaxhighlight>

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

GetResourceLastStartTime

2007-07-30T09:49:56Z

Black Dragon:

__NOTOC__
Used to check the last starting time and date of a function

==Syntax==
<syntaxhighlight lang="lua">string getResourceLastStartTime ( resource theResource )</syntaxhighlight>

===Required Arguments===
*'''theResource:''' The resource of which you'd like to check the last starting time and date.

===Returns===
Returns a string with the time and date, or false if the resource does not exist.

==Example==
This function outputs to chatbox when the current resource was started.
<syntaxhighlight lang="lua">
function whenStarted()
local startTime = getResourceLastStartTime ( getThisResource() ) --Get the time and date
outputChatBox( "This resource was started on: " .. startTime ) --tell everybody when the current resource was started.
end
</syntaxhighlight>

==See Also==
{{Resource functions}}

GetResourceInfo

2007-07-30T09:37:57Z

Black Dragon:

{{Needs_Checking|may return a string, bool or nil (?) --[[User:Jbeta|jbeta]]}}
__NOTOC__
This function retrieves the value of any attribute in a resource info tag.

==Syntax==
<syntaxhighlight lang="lua">
string getResourceInfo ( resource theResource, string attribute )
</syntaxhighlight>

===Required Arguments===
*'''theResource:''' the resource we are getting the info from.
*'''attribute:''' the name of the attribute we want info about.

===Returns===
Returns a ''string'' with the attribute value if it exists, ''false'' otherwise.

==Example==
This function tells the server who's the author who made the currently running resource.
<syntaxhighlight lang="lua">
function outputAuthor()
author = getResourceInfo ( getThisResource(), "author" ) --Get the authors name
if author then --if it exists
outputChatBox( author .. " made this script." ) --tell the world his name
else --if it doesn't
outputChatBox( "I've no idea who made this script." ) --apologize.
end
end
</syntaxhighlight>

==See Also==
{{Resource_functions}}

GetResourceConfig

2007-07-30T09:23:48Z

Black Dragon:

__NOTOC__
This function is used to return the root node of a configuration file. Config files must be predefined in a resource's [[meta file]].

==Syntax==
<syntaxhighlight lang="lua">
xmlnode getResourceConfig ( [resource theResource = getThisResource()], string filename )
</syntaxhighlight>

===Required Arguments===
*'''filename:''' The exact file name of the configuration file. (e.g. "file.xml" )

===Optional Arguments===
*'''theResource:''' The resource from which the function calls the configuration file

===Returns===
Returns the root node of the specified configuration file. If the file is corrupted, not defined in the meta file or doesn't exist, returns false.

==Example==
In the example
<syntaxhighlight lang="lua">
function resourceStart ( resourcename ) --When the resource is started
if ( resourcename == getThisResource () ) then --if the resource is this one
node = getResourceConfig( resourcename, "file.xml" ) --get the configuration file
local subNode = xmlFindSubNode( node, "group", 1 ) --get a subnode in it
outputChatBox( xmlNodeGetAttribute( node, "attr" ) ) --output its' the attributes value to chatbox.
end
end
addEventHandler ( "onResourceStart", getRootElement(), resourceStart )
</syntaxhighlight>

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

GetRadarAreaSize

2007-07-30T09:12:45Z

Black Dragon:

__NOTOC__
Used for getting the X and Y size of an existing radar area.

==Syntax==
<syntaxhighlight lang="lua">
float float getRadarAreaSize ( radararea theRadararea )
</syntaxhighlight>

===Required Arguments===
*'''theRadararea:''' The radararea element whose size you wish to get.

===Returns===
Returns two ''floats'' indicating the X and Y length of the radar area respectively, ''false'' if the radar area doesn't exist.

==Example==
The following example looks for radar areas whose size is smaller than 100 by 100:
<syntaxhighlight lang="lua">
radarareas = getElementsByType ( "radararea" ) -- get a tabele of radararea elements
for k,v in ipairs(radarareas) do -- use a generic for loop to step through each of the elements
local sizeX, sizeY = getRadarAreaSize ( v ) -- get the size of the radar area
if ( sizeX < 100 and sizeY < 100 ) then -- check if it's smaller than 100 by 100
outputChatBox ( "A small radar area was found!" )
end
end
</syntaxhighlight>
This example creates a radar area and stores it's size in variables x and y:
<syntaxhighlight lang="lua">
greenArea = createRadarArea ( 1024, 1024, 50, 120, 0, 220, 0, 85 )
local x, y = getRadarAreaSize ( greenArea )
</syntaxhighlight>

==See Also==
{{Radar area_functions}}

GetPlayerWantedLevel

2007-07-30T09:01:29Z

Black Dragon: /* Example */

__NOTOC__
This function gets a player's current wanted level. The wanted level is indicated by the amount of stars a player has on the [[HUD]].

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

===Required Arguments===
*'''thePlayer:''' The player whose wanted level you wish to get

===Returns===
Returns an ''int'' from 0 to 6 representing the player's wanted level, ''false'' if the player does not exist.

==Example==
This example finds which players in the server have a wanted level:
<syntaxhighlight lang="lua">
local players = getElementsByType ( "player" ) -- get a table of all the players in the server
for theKey,thePlayer in ipairs(players) do -- use a generic for loop to step through each player
local level = getPlayerWantedLevel ( thePlayer ) -- get the wanted level of the player
if ( level > 0 ) then -- if the player has any stars, announce it in the chat:
outputChatBox ( getClientName ( thePlayer ) .. " has a wanted level of " .. level .. " stars!" )
end
end
</syntaxhighlight>

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

SetVehicleLandingGearDown

2007-06-20T17:06:41Z

Black Dragon:

__NOTOC__
This function is used to set the landing gear state of certain vehicles.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleLandingGearDown ( vehicle thevehicle, bool gearstate )
</syntaxhighlight>

===Required Arguments===
*'''thevehicle:''' The vehicle of which you wish to set the landing gear state.
*'''gearstate:''' ''true'' or ''false''.

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==

This example does...

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

==See Also==

{{Vehicle functions}}
[[Category:Incomplete]]

SetVehicleDoorsUndamageable

2007-06-20T17:03:06Z

Black Dragon:

__NOTOC__
This function is used to make a cars doors undamageable.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDoorsUndamageable ( vehicle thevehicle, bool state )
</syntaxhighlight>

===Required Arguments===
*'''thevehicle:''' The vehicle of which you wish to set the car door damageability.
*'''state:''' ''true'' or ''false''.

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==

This example does...

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

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

SetSkyGradient

2007-06-20T16:56:48Z

Black Dragon:

__NOTOC__
This function changes the sky color to a gradient.

==Syntax==
<syntaxhighlight lang="lua">
bool setSkyGradient ( [ int topRed = 0, int topGreen = 0, int topBlue = 0, int bottomRed = 0, int bottomGreen = 0, int bottomBlue = 0 ] )
</syntaxhighlight>

===Optional Arguments===
{{OptionalArg}}
*'''topRed:''' The ''red'' value of the upper part of the sky.
*'''topGreen:''' The ''green'' value of the upper part of the sky.
*'''topBlue:''' The ''blue'' value of the upper part of the sky.
*'''bottomRed:''' The ''red'' value of the lower part of the sky.
*'''bottomGreen:''' The ''green'' value of the lower part of the sky.
*'''bottomBlue:''' The ''blue'' value of the lower part of the sky.

===Returns===
Returns ''true'' if sky color was set correctly, ''false'' if the values go beyond 0 to 256, or are not numeric.

==Example==
This example sets the sky to a hot pink color.
<syntaxhighlight lang="lua">
setSkyGradient( 200, 0, 100, 200, 0, 100 )
</syntaxhighlight>

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

SetMapName

2007-06-20T16:51:00Z

Black Dragon:

__NOTOC__
This function is used to set a map name that will be visible via The All Seeing Eye.

==Syntax==
<syntaxhighlight lang="lua">
bool setMapName ( string mapName )
</syntaxhighlight>

===Required Arguments===
*'''mapName:''' The name you wish ASE to show.

===Returns===
Returns ''true'' if map name was set successfully, ''false'' otherwise.

==Example==

This example does...

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

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

GetVehicleLandingGearDown

2007-06-20T16:38:58Z

Black Dragon:

__NOTOC__
This function is used to check whether a vehicles' landing gear is down or not.

==Syntax==
<syntaxhighlight lang="lua">
bool getVehicleLandingGearDown ( vehicle thevehicle )
</syntaxhighlight>

===Required Arguments===
*'''thevehicle:''' The vehicle that you wish to check its' landing gear state.

===Returns===
Returns ''true'' if landing gear is down, ''false'' if the landing gear is up. 
Returns ''nil'' if the vehicle has no landing gear, or is invalid.

==Example==

This example does...

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

==See Also==

{{Vehicle functions}}
[[Category:Incomplete]]

GetResourceName

2007-06-20T16:35:32Z

Black Dragon:

__NOTOC__
This function is used to get resources names.

==Syntax==
<syntaxhighlight lang="lua">
string getResourceName ( resource )
</syntaxhighlight>

===Required Arguments===
*'''resource:''' The resource you wish to get the name of.

===Returns===
Returns a string with the resource name in it, or ''false'' if the resource does not exist.

==Example==

This example does...

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

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

GetResourceLoadFailureReason

2007-06-20T16:33:09Z

Black Dragon:

__NOTOC__
This function is used to determinate the reason for a resource to not start.

==Syntax==
<syntaxhighlight lang="lua">
string getResourceLoadFailureReason ( resource )
</syntaxhighlight>

===Required Arguments===
*'''resource:''' The resource you wish to check.

===Returns===
Returns a string with the failure reason in it, or ''false'' if the resource doesn't exist.

==Example==

This example does...

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

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

TriggerServerEvent

2007-06-20T15:25:13Z

Black Dragon:

__NOTOC__
This function triggers an event on servers. This is the primary means of passing information between the client and the server. Servers have a similar [[triggerClientEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerClientEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[elements]] and complex nested [[tables]]. Special data types like xmlNodes will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so the server will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. It is marginally more efficient to pass one large event than two smaller ones.

==Syntax==
<syntaxhighlight lang="lua">
bool triggerServerEvent ( string event, element theElement, [arguments...] )
</syntaxhighlight>

===Required Arguments===
*'''event:''' The name of the event to trigger server-side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''theElement:''' The element that is the ''source'' of the event. This could be another player, or if this isn't relevant, use the root element.

===Optional Arguments===
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[elements]].

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Example==
This example shows how you can pass a simple "Hello World" message from the client to the server using an event.

'''Server:'''
<syntaxhighlight lang="lua">
addEvent("onGreeting")
addEventHandler("onGreeting", getRootElement(), "greetingHandler")
function greetingHandler ( message )
outputChatBox ( "The client says: " .. message )
end
</syntaxhighlight>

'''Client:'''
<syntaxhighlight lang="lua">
addCommandHandler ( "greet", "greetingCommand" )
function greetingCommand ( source, commandName )
triggerServerEvent ( "onGreeting", getRootElement(), "Hello World!" )
end
</syntaxhighlight>
When the command "greet" is executed (by typing it in the server console or the player's console), the clients ''greetingCommand'' function is called. This triggers the server-side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function server-side which then displays the message.

==See Also==
{{FunctionArea_functions}}

TriggerClientEvent

2007-06-20T15:14:02Z

Black Dragon:

__NOTOC__
This function triggers an event on clients. This is the primary means of passing information between the server and the client. Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[elements]] and complex nested [[tables]]. Special data types like xmlNodes will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. It is marginally more efficient to pass one large event than two smaller ones.

==Syntax==
<syntaxhighlight lang="lua">
bool triggerClientEvent ( [element triggerFor=getRootElement()], string name, element theElement, [arguments...] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''theElement:''' The element that is the ''source'' of the event. This could be another player, or if this isn't relevant, use the root element.


===Optional Arguments===
{{OptionalArg}}
*'''triggerFor:''' The event will be triggered on all [[players]] that are children of the specified element. By default this is the root element, and hence the event is triggered on all elements. If you specify a single player it will just be triggered for that player.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[elements]].

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Example==
This example shows how you can pass a simple "Hello World" message from the server to the client using an event.

'''Client:'''
<syntaxhighlight lang="lua">
addEvent("onGreeting")
addEventHandler("onGreeting", getRootElement(), "greetingHandler")
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
</syntaxhighlight>

'''Server:'''
<syntaxhighlight lang="lua">
addCommandHandler ( "greet", "greetingCommand" )
function greetingCommand ( source, commandName )
triggerClientEvent ( "onGreeting", getRootElement(), "Hello World!" )
end
</syntaxhighlight>
When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.

==See Also==
{{Event_functions}}

XmlSaveFile

2007-06-20T15:12:38Z

Black Dragon:

__NOTOC__
This function saves a loaded XML file.

==Syntax==
<syntaxhighlight lang="lua">bool xmlSaveFile ( xmlnode rootNode ) </syntaxhighlight>

===Required Arguments===
*'''rootNode:''' the root [[xmlnode]] of the loaded XML file.

===Returns===
Returns ''true'' if save was successful, ''false'' if the XML file does not exist.

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

==See Also==
{{XML_functions}}
[[Category:Incomplete]]

XmlNodeSetAttribute

2007-06-20T15:10:45Z

Black Dragon:

__NOTOC__
This function is used to edit an attribute of a node in a configuration file.

==Syntax==
<syntaxhighlight lang="lua">
bool xmlNodeSetAttribute ( xmlnode xmlnode, string name, var value )
</syntaxhighlight>

===Required Arguments===
*'''xmlnode:''' The node in which you wish to edit the attribute.
*'''name:''' The name of the attribute.
*'''value:''' The value which you wish to change the attribute to.

===Returns===
Returns ''true'' if edit was successful, ''false'' if the node and/or attribute do not exist, or if they're faulty.

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

==See Also==
{{FunctionArea_Functions}}
{{XML_functions}}
[[Category:Incomplete]]

XmlNodeGetAttribute

2007-06-20T15:06:04Z

Black Dragon:

__NOTOC__
This function is used to return an attribute of a node in a configuration file.

==Syntax==
<syntaxhighlight lang="lua">
string xmlNodeGetAttribute ( xmlnode xmlnode, string name )
</syntaxhighlight>

===Required Arguments===
*'''xmlnode:''' The node from which you wish to return the attribute
*'''name:''' The name of the attribute.

===Returns===
Returns the attribute in string form.

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

==See Also==
{{FunctionArea_Functions}}
{{XML_functions}}
[[Category:Incomplete]]

RemoveAccount

2007-06-20T14:56:10Z

Black Dragon:

__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">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]]

SpawnVehicle

2007-06-20T14:53:22Z

Black Dragon:

__NOTOC__
Respawns vehicles to where they were first spawned.

==Syntax==
<syntaxhighlight lang="lua">
bool respawnVehicle ( vehicle thevehicle )
</syntaxhighlight>

===Required Arguments===
*'''thevehicle:''' The vehicle you wish to respawn

===Returns===
Returns ''true'' if the vehicle respawned successfully, ''false'' if the passed argument does not exist or is not a vehicle.

==Example==

This example does...

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

==See Also==

{{Vehicle functions}}
[[Category:Incomplete]]

IsVehicleOnGround

2007-06-20T14:48:09Z

Black Dragon:

__NOTOC__
Checks to see if a vehicle has contact with the ground.

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleOnGround ( vehicle thevehicle )
</syntaxhighlight>

===Required Arguments===
*'''thevehicle:''' The vehicle you wish to check.

===Returns===
Returns ''true'' if vehicle is on the ground, ''false'' otherwise.

==Example==

This example does...

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

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

IsElementAttached

2007-06-20T14:44:53Z

Black Dragon:

__NOTOC__

This functions checks whether or not an element is attached to another element.

==Syntax==

<syntaxhighlight lang="lua">
bool isElementAttached ( theElement )
</syntaxhighlight>

===Required Arguments===

*'''theElement:''' The element to check for attachment.

===Returns===

Returns ''true'' if the specified element is attached to another element, ''false'' if it is not attached or if an improper argument is passed.

==Example==

This examples checks if a player is attached to anything when they enter a console command:

<syntaxhighlight lang="lua">
-- add a command handler for 'amiattached' to call the function 'consoleIsPlayerAttached':
addCommandHandler ( "amiattached", "consoleIsPlayerAttached" )
function consoleIsPlayerAttached ( player, command )
if ( player ) then -- if a player triggered this command
local status = isElementAttached ( player ) -- call the function and store it's result in the 'status' variable
if ( status ) then -- if the function returned true, tell the player he is attached to something
outputConsole ( "You are attached to an element!", player )
else -- if the function returned false, tell the player he is not attached to anything
outputConsole ( "You are not attached to an element.", player )
end
end
end
</syntaxhighlight>

==See Also==
{{Element_functions}}

IsControlEnabled

2007-06-20T14:43:28Z

Black Dragon:

__NOTOC__
Checks whether a GTA control is enabled or disabled for a certain player.

==Syntax==
<syntaxhighlight lang="lua">
bool isControlEnabled ( player theplayer, string control )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish the control status of.
*'''control:''' The control you wish to check. See [[control names]] for a list of possible controls.

===Returns===
Returns ''true'' if control is enabled, ''false'' otherwise.

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

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]] -- leave this unless you complete the function

GetResourceConfig

2007-06-14T09:07:46Z

Black Dragon:

__NOTOC__

This function is used to return the root node of a configuration file. (defined in meta.xml)

==Syntax==

<syntaxhighlight lang="lua">
xmlnode getResourceConfig ( resource theResource, string filename )
</syntaxhighlight>

===Required Arguments===

*'''theResource:''' The resource from which the function calls the configuration file
*'''filename:''' The exact file name of the configuration file. (e.g. "file.xml" )

===Returns===

Returns the root node of the specified configuration file. If the file is corrupted, not defined in meta.xml or doesn't exist, returns false.

==Example==

==See Also==

{{FunctionArea_functions}}
[[Category:Incomplete]]

GetElementBoundingBox

2007-06-14T08:15:32Z

Black Dragon:

__NOTOC__
This function returns the minimum and maximum x,y,z coords of an element's bounding box.

==Syntax==
<syntaxhighlight lang="lua">
float float float float float float getElementBoundingBox ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' the element whose bounding box we want to get.

===Returns===
*Returns ''min x, min y, min z, max x, max y, max z'' if the passed element is valid, ''false'' otherwise.

==Example==
This example outputs to chatbox the minimum and the maximum coords of an element. If the element doesn't exist or doesn't have such coords, it outputs "false".
<syntaxhighlight lang="lua">
function minMaxOutput( element )
x0, y0, z0, x1, y1, z1 = getElementBoundingBox ( element )
if ( x0 ) then
outputChatBox( "The coords are: " .. x0 .. ", " .. y0 .. ", " .. z0 .. ", " .. x1 .. ", " .. y1 .. ", " .. z1 )
else
outputChatBox( "false" )
end
end
</syntaxhighlight>

==See Also==
{{Client element functions}}

GetCameraTarget

2007-06-14T08:05:20Z

Black Dragon:

__NOTOC__
This function returns an [[element]] that corresponds to the current target of the specified player's camera (i.e. what it is following).
==Syntax==
<syntaxhighlight lang="lua">
element getCameraTarget ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to receive the target of.

===Returns===
Returns an [[element]] if the function was successful, ''false'' otherwise.

==Example==
This example checks wether a players cameras target is another player, and returns true or false accordingly.
<syntaxhighlight lang="lua">
function isTargetPlayer( player )
local target = getCameraTarget( player )
if ( getElementType ( target ) == "player" ) then --If target is a player
return true --Return true
else
return false --Otherwise, return false.
end
end
</syntaxhighlight>
==See Also==
{{Camera functions}}

GetCameraTarget

2007-06-14T08:01:09Z

Black Dragon:

__NOTOC__
This function returns an [[element]] that corresponds to the current target of the specified player's camera (i.e. what it is following).
==Syntax==
<syntaxhighlight lang="lua">
element getCameraTarget ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera you wish to receive the target of.

===Returns===
Returns an [[element]] if the function was successful, ''false'' otherwise.

==Example==
This example returns the element which was set as the players cameras target, otherwise, returning false.
<syntaxhighlight lang="lua">
function returnCamTarget( player )
local target = getCameraTarget( player )
if ( target ) then --If target is not false
return target --Return target
else
return false --Otherwise, return false.
end
end
</syntaxhighlight>
==See Also==
{{Camera functions}}

AddAccount

2007-06-14T07:49:56Z

Black Dragon:

__NOTOC__
This function adds an account to the list of registered account of the current server.

==Syntax==

<syntaxhighlight lang="lua">
bool addAccount ( string name, string pass, int level )
</syntaxhighlight>

===Required Arguments===

*'''name:''' The name of the account you wish to make, this normally is the Players Name.
*'''pass:''' The password to set to this account for future logins.
*'''level:''' The account level (see below for more detailed level values)

Level Notes:
You may specify any level here, normally the account level is used for future use such as creating an admin system...

You can check the current players access level with this command: [[getClientLevel]]



===Returns===

Returns ''true'' if the account was created, ''false'' if the account allready exists, or if an error occoured.

==Example==

In this example, it enables players to register on your server by using /register <password> in the chat window.

<syntaxhighlight lang="lua">
addCommandHandler ( "register", root, "registerPlayer" )
function registerPlayer ( source, password )
--Check if the password field is blank or not (only blank if they didnt enter one)
if ( password ~= "" or password ~= nil ) then
--Attempt to add the account, and save its value in a var
local accountAdded = addAccount( getClientName(source), password, 0 )
if ( accountAdded ) then
--Tell the user its all done
outputChatBox ( "Thankyou " .. getClientName(source) .. ", you're now registed, you can login with /login", source )
else
--There was an error making the account, tell the user
outputChatBox ( "Error Creating Account, Contact the server admin", source )
end
else
--There was an error in the syntax, tell the user the correct syntax.
outputChatBox ( "Error Creating Account, correct syntax: /register <password>", source )
end
end
</syntaxhighlight>

==See Also==

{{FunctionArea_functions}}

OnClientColShapeHit

2007-06-14T07:47:08Z

Black Dragon:

__NOTOC__
This event triggers whenever an element enters a collision shape.

==Syntax==
<syntaxhighlight lang="lua">
void onClientColShapeHit ( entity theEntity, bool matchingDimension )
</syntaxhighlight>

==Example==
This example outputs "In." to the chatbox whenever a local user enters a collision shape.
<syntaxhighlight lang="lua">
function onClientColShapeHit( theEntity, matchingDimension )
if ( theEntity == getLocalPlayer() ) then --Checks whether the entering entity is the local player
outputChatBox( "In." ) --Outputs.
end
end
</syntaxhighlight>

OnClientColShapeLeave

2007-06-14T07:27:47Z

Black Dragon:

__NOTOC__
This event triggers whenever an element leaves a collision shape.

==Syntax==
<syntaxhighlight lang="lua">
void onClientColShapeLeave ( entity theEntity, bool matchingDimension )
</syntaxhighlight>

==Example==
This example outputs "Out." to the chatbox whenever a local user leaves a collision shape.
<syntaxhighlight lang="lua">
function onClientColShapeLeave( theEntity, matchingDimension )
if ( theEntity == getLocalPlayer() ) then --Checks whether the leaving entity is the local player
outputChatBox( "Out." ) --Outputs.
end
end
</syntaxhighlight>

OnClientColShapeHit

2007-06-14T07:25:34Z

Black Dragon:

[[Category:Incomplete Event]]

__NOTOC__
This event triggers whenever an element enters a collision shape.

==Syntax==
<syntaxhighlight lang="lua">
void onClientColShapeHit ( entity theEntity, bool matchingDimension )
</syntaxhighlight>

==Example==
This example outputs "In." to the chatbox whenever a local user enters a collision shape.
<syntaxhighlight lang="lua">
function onClientColShapeHit( theEntity, matchingDimension )
if ( theEntity == getLocalPlayer() ) then --Checks whether the entering entity is the local player
outputChatBox( "In." ) --Outputs.
end
end
</syntaxhighlight>

GetCameraPosition

2007-04-19T12:20:24Z

Black Dragon:

{{Needs_Checking|Returns 0 0 0 with script:
<pre>addCommandHandler ( "getcampos", "retrieveCameraPosition" )
function retrieveCameraPosition ( player, commandName )
local camx, camy, camz = getCameraPosition ( player )
outputChatBox ( "X: "..camx.." Y: "..camy.." Z: "..camz )
end</pre>--[[User:Ransom|Ransom]] 17:17, 11 April 2007 (CDT)}}

__NOTOC__
This function returns the position the player's camera would have if the camera mode is fixed (see [[setCameraMode]]).
==Syntax==
<syntaxhighlight lang="lua">
float float float getCameraPosition ( player thePlayer )
</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player whose camera position you wish to obtain.

===Returns===
Returns three [[float|floats]] containing the x, y and z co-ordinate values if the function was successful, ''false'' otherwise.

==Example==

This example does...

<syntaxhighlight lang="lua">
addCommandHandler( "check", "checkCamera" )
function checkCamera( source )
if ( getCameraMode( source ) == "fixed" ) then --If the camera is fixed...
local camx, camy, camz = getCameraPosition( source ) --Get the cameras position
outputConsole( camx .. " " .. camy .. " " .. camz, source ) --And output it.
else
outputConsole( "The camera is not fixed", source ) --If not, say so.
end
end
</syntaxhighlight>

==See Also==
{{Camera functions}}