Multi Theft Auto: Wiki - User contributions [en]

TakeAllWeapons

2013-04-23T14:20:27Z

MrX: Can also be used on Peds

__NOTOC__
{{Server function}}
This function removes every weapons from a specified ped, rendering it unarmed.
{{Note|Weapons are removed when a ped dies by default. This means that it is only appropriate to use this function while a ped is alive.}}

==Syntax==
<syntaxhighlight lang="lua">bool takeAllWeapons ( ped thePed )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': A [[ped]] element referencing the specified ped

===Returns===
Returns ''true'' if the function succeeded, ''false'' otherwise.

==Example==
This example removes all weapons from every player
<syntaxhighlight lang="lua">
takeAllWeapons ( getRootElement() ) --remove all the weapons
outputChatBox ( "Weapons are not permitted!" ) --tell the players why they lost their weapons</syntaxhighlight>

==See Also==
{{Weapon functions}}
[[ru:takeAllWeapons]]

Template:Useful Functions

2013-03-28T17:11:08Z

MrX:

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

HasObjectPermissionTo

2012-08-18T15:29:09Z

MrX: "Ban command" -> "Kick command" in the example

__NOTOC__
{{Server function}}
This function returns whether or not the given object has access to perform the given action.

Scripts frequently wish to limit access to features to particular users. The naïve way to do this would be to check if the player who is attempting to perform an action is in a particular group (usually the Admin group). The main issue with doing this is that the Admin group is not guaranteed to exist. It also doesn't give the server admin any flexibility. He might want to allow his 'moderators' access to the function you're limiting access to, or he may want it disabled entirely.

This is where using the ACL properly comes in, and luckily this is very easy. It all comes down to using this function. This, somewhat confusingly named function lets you check if an ACL object (a player or a resource) has a particular ACL right. In this case, we just care about players.

So, first of all, think of a name for your 'right'. Let's say we want a private area only certain people can go in, we'll call our right accessPrivateArea. Then, all you need to do is add one 'if' statement to your code:
<syntaxhighlight lang="lua">if hasObjectPermissionTo ( player, "resource.YourResourceName.accessPrivateArea", false ) then
-- Whatever you want to happen if they're allowed in
else
-- Whatever you want to happen if they aren't
end
</syntaxhighlight>

Notice that we've named the ''right'' using ''resource.YourResourceName.accessPrivateArea'' - this is just for neatness, so that the admin knows what resource the right belongs to. It's strongly advised you follow this convention. The ''false'' argument specifies the 'defaultPermission', false indicating that if the user hasn't had the right allowed or dissallowed (i.e. the admin hasn't added it to the config), that it should default to being not allowed.

The only downside of using this method is that the admin has to modify his config. The upsides are that the admin has much more control and your script will work for any server, however the admin has configured it.

==Syntax==
<syntaxhighlight lang="lua">
bool hasObjectPermissionTo ( string / element theObject, string theAction [, bool defaultPermission = true ] )
</syntaxhighlight>

===Required Arguments===
*'''theObject:''' The object to test if has permission to. This can be a client element (ie. a player), a resource or a string in the form "user.<name>" or "resource.<name>".
*'''theAction:''' The action to test if the given object has access to. Ie. "function.kickPlayer".

===Optional Arguments===
{{OptionalArg}}
*'''defaultPermission:''' The default permission if none is specified in either of the groups the given object is a member of. If this is left to true, the given object will have permissions to perform the action unless the opposite is explicitly specified in the [[ACL]]. If false, the action will be denied by default unless explicitly approved by the [[Access Control List]].

===Returns===
Returns ''true'' if the given object has permission to perform the given action, ''false'' otherwise. Returns ''nil'' if the function failed because of bad arguments.

==Example==
This example kicks a player if the user using it has access to the kickPlayer function.
<syntaxhighlight lang="lua">
-- Kick command
function onKickCommandHandler ( playerSource, commandName, playerToKick, stringReason )
-- Does the calling user have permission to kick the player? Default
-- to false for safety reasons. We do this so any user can't use us to
-- kick players.
if ( hasObjectPermissionTo ( playerSource, "function.kickPlayer", false ) ) then

-- Do we have permission to kick the player? We do this so we can fail
-- nicely if this resource doesn't have access to call that function.
if ( hasObjectPermissionTo ( getThisResource (), "function.kickPlayer", true ) ) then
-- Kick him
kickPlayer ( playerToKick, playerSource, stringReason )
else
-- Resource doesn't have any permissions, sorry
outputChatBox ( "kick: The admin resource is not able to kick players. Please give this resource access to 'function.kickPlayer' in the ACL to use this function.", playerSource )
end
else
-- User doesn't have any permissions
outputChatBox ( "kick: You don't have permissions to use this command.", playerSource )
end
end
addCommandHandler ( "kick", onKickCommandHandler )
</syntaxhighlight>

==See Also==

{{ACL_functions}}

DxDrawImage3D

2012-06-27T01:03:32Z

MrX: fixed rotation being an optional parameter, fixed example

{{Useful Function}}
__NOTOC__
This function draws a textured 3D line between two points in the 3D world that appers to be a 3D image - rendered for one frame This should be used in conjunction with [[onClientPreRender]] in order to display continuously.

The 3D line with a large width value and a texture effectively becomes a 3D image, hence the possibility to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.

3D lines are drawn at a particular place in the [[Game_Processing_Order|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements. 
* '''NOTE:''' This is made to be used clientside!.

==Syntax==
<syntaxhighlight lang="lua">bool dxDraw3DImage ( float x, float y, float z, float width, float height, element material[, int color, float rotation, float faceTowardX, float faceTowardY, float faceTowardZ]</syntaxhighlight>

===Required Arguments===
* '''X/Y/Z:''' The start position of the 3D image, representing a coordinate in the GTA world.
* '''width:''' The width of the image in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)
* '''height:''' The height of the image in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)
* '''material:''' A material to draw the image with.

==Optional Arguments==
{{OptionalArg}}
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''rotation:''' Rotation (end point of the image) offset
* '''faceTowardX/Y/Z:''' The direction the front of the image should face towards. If this is not set, the front of the image always faces toward the camera.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
local white = tocolor(255,255,255,255)
function dxDrawImage3D(x,y,z,w,h,m,c,r,...)
local lx, ly, lz = x+w, y+h, (z+tonumber(r or 0)) or z
return dxDrawMaterialLine3D(x,y,z, lx, ly, lz, m, h, c or white, ...)
end
</syntaxhighlight>
</section>

==Example==
This draws a trollface in the middle of the GTA world for no reason
<syntaxhighlight lang="lua">
local face = dxCreateTexture("trollface.png")
addEventHandler("onClientRender", root,
function()
dxDrawImage3D(0,0, 20, 20, 20, face, tocolor(255,255,255,255))
end
end
</syntaxhighlight>

Author: qaisjp

==See Also==
{{Useful_Functions}}

DxDrawRectangle3D

2012-06-27T01:02:32Z

MrX:

{{Useful Function}}
__NOTOC__
This function draws a textured 3D line between two points in the 3D world that appers to be a rectangle - rendered for one frame This should be used in conjunction with [[onClientPreRender]] in order to display continuously.

The 3D line with a large width value effectively becomes a rectangle, hence the possibility to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.

3D lines are drawn at a particular place in the [[Game_Processing_Order|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements. 
* '''NOTE:''' This is made to be used clientside!.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawRectangle3D ( float x, float y, float z, float width, float height[, int color, float rotation, float faceTowardX, float faceTowardY, float faceTowardZ]</syntaxhighlight>

===Required Arguments===
* '''X/Y/Z:''' The start position of the 3D rectangle, representing a coordinate in the GTA world.
* '''width:''' The width of the rect in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)
* '''height:''' The height of the rect in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)

==Optional Arguments==
{{OptionalArg}}
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''rotation:''' Rotation (end point of the rect) offset
* '''faceTowardX/Y/Z:''' The direction the front of the rect should face towards. If this is not set, the front of the rect always faces toward the camera.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
local dot = dxCreateTexture(1,1)
local white = tocolor(255,255,255,255)
function dxDrawRectangle3D(x,y,z,w,h,c,r,...)
local lx, ly, lz = x+w, y+h, (z+tonumber(r or 0)) or z
return dxDrawMaterialLine3D(x,y,z, lx, ly, lz, dot, h, c or white, ...)
end
</syntaxhighlight>
</section>

==Example==
This draws a white rectangle in the middle of the GTA world for no reason
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", root,
function()
dxDrawRectangle3D(0,0, 20, 20, 20, tocolor(255,255,255,255))
end
end
</syntaxhighlight>

Author: qaisjp

==See Also==
{{Useful_Functions}}

DxDrawRectangle3D

2012-06-27T01:02:01Z

MrX: fixed rotation being an optional parameter

{{Useful Function}}
__NOTOC__
This function draws a textured 3D line between two points in the 3D world that appers to be a rectangle - rendered for one frame This should be used in conjunction with [[onClientPreRender]] in order to display continuously.

The 3D line with a large width value effectively becomes a rectangle, hence the possibility to construct basic shapes such as boxes with several large width lines and the appropriate values for 'faceToward'.

3D lines are drawn at a particular place in the [[Game_Processing_Order|game processing order]], so use [[onClientPreRender]] for drawing if you are attaching them to world elements. 
* '''NOTE:''' This is made to be used clientside!.

==Syntax==
<syntaxhighlight lang="lua">bool dxDrawRectangle3D ( float x, float y, float z, float width, float height[, int color, float rotation, float faceTowardX, float faceTowardY, float faceTowardZ]</syntaxhighlight>

===Required Arguments===
* '''X/Y/Z:''' The start position of the 3D rectangle, representing a coordinate in the GTA world.
* '''width:''' The width of the rect in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)
* '''height:''' The height of the rect in GTA world units. (This is 1/75th of the width used in dxDrawLine3D)

==Optional Arguments==
{{OptionalArg}}
* '''color:''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue).
* '''rotation:''' Rotation (end point of the rect) offset
* '''faceTowardX/Y/Z:''' The direction the front of the rect should face towards. If this is not set, the front of the rect always faces toward the camera.

===Returns===
Returns a ''true'' if the operation was successful, ''false'' otherwise.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
local dot = dxCreateTexture(1,1)
local white = tocolor(255,255,255,255)
function dxDrawRectangle3D(x,y,z,w,h,c,r,...)
r = r or 0
local lx, ly, lz = x+w, y+h, (z+tonumber(r)) or z
return dxDrawMaterialLine3D(x,y,z, lx, ly, lz, dot, h, c or white, ...)
end
</syntaxhighlight>
</section>

==Example==
This draws a white rectangle in the middle of the GTA world for no reason
<syntaxhighlight lang="lua">
addEventHandler("onClientRender", root,
function()
dxDrawRectangle3D(0,0, 20, 20, 20, tocolor(255,255,255,255))
end
end
</syntaxhighlight>

Author: qaisjp

==See Also==
{{Useful_Functions}}

Resource:Mapmanager

2011-03-21T22:14:52Z

MrX: Undo revision 25502 by HYp3R (talk) English...

{{Resource page}}
The map manager is a resource included in the MTA DM server suite. It offers commands, functions and events for the gamemodes to dynamically manage their maps. For example, when a race server needs to load different tracks for each race, instead of having all of them in the same resource as the main script, they can be stored in separate resources and then loaded simply with the "changeGamemodeMap" function when a new race starts.

Specifically, the map manager lists gamemodes/maps and manages gamemode/map loading. It applies certain map settings affecting the game world and sets ASE game type and map name rule values as well. It includes a web listing which autoupdates and highglights the current mode/map combination.

==A simple tutorial==
In this section we are going to continue the basic gamemode we created in the [[Scripting Introduction|Introduction to Scripting]]. We will add a simple map resource that only contains the spawnpoint data for the players, and load the data in the main script when the player needs to spawn.

First of all, we make a folder under /Your MTA Server/mods/deathmatch/resources/, and name it "mymap". Then under /mymap/ directory, create a text file and name it "meta.xml", which is required for every resource.

Enter the following codes in the ''meta.xml'' file:
<syntaxhighlight lang="xml">
<meta>
<info type="map" gamemodes="myserver"/>
<map src="mymap.map"/>
</meta>
</syntaxhighlight>
Note that this resource is "linked" to the main resource with the ''gamemodes=""'' tag, which contains the name of the main resource. In the ''map'' tag, it indicates the name of the .map file which contains the actual map data.

Now let's create another text file under /mymap/ and name it "mymap.map", and enter the following codes:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="18" rot="63.350006103516" model="0"/>
</map>
</syntaxhighlight>
Note that "spawnpoint" is the type of the element, used in [[getElementsByType]] function; likewise, "id" is used in [[getElementByID]] function.

To load the map data, the main script needs access to the map resource itself. Now let's edit the script.lua file in "myserver" resource. Enter the following code:

<syntaxhighlight lang="lua">
function loadMap(startedMap)
mapRoot = getResourceRootElement(startedMap)
end

addEventHandler("onGamemodeMapStart", getRootElement(), loadMap)
</syntaxhighlight>
Basically, the "onGamemodeMapStart" event gives us the handle of the map ("startedMap"), which we used to extract the handle of the resource containing the map ("mapRoot").

With the resource handle, we can extract the spawnpoint information from it. Look at the joinHandler() function in script.lua, instead of specifying x, y and z, we can use the map data as the following:
<syntaxhighlight lang="lua">
function joinHandler()
local spawn = getElementsByType("spawnpoint", mapRoot)
local x,y,z,r
for key, value in pairs(spawn) do
x = getElementData(value, "posX")
y = getElementData(value, "posY")
z = getElementData(value, "posZ")
r = getElementData(value, "rot")
end
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
end
</syntaxhighlight>
Now you may start the gamemode in the server console with the following command:

'''gamemode myserver mymap'''

==Usage==
To use the map manager, your resources must first be marked as either gamemodes or maps.

You have to tag the '''gamemode resource''' with the correct type in its info tag:
<syntaxhighlight lang="xml"><info description="A gamemode" type="gamemode" /></syntaxhighlight>

'''Map resources''' also need the ''type="map"'' tag, plus a ''gamemodes'' tag listing the gamemode resources they're compatible with in a comma-separated list ''without spaces''.
<syntaxhighlight lang="xml"><info description="A gamemode map" type="map" gamemodes="ctv,koth" /></syntaxhighlight>

There can be only one gamemode and one gamemode map loaded at once.

==Optional resource attributes==
These attributes all go in the corresponding resource's info tag.

'''name:''' A friendly name for your gamemode or map, to be displayed in the start messages or map listings instead of the filename.

==Commands==
'''changemap newmap [newgamemode]''' (changes the gamemode map to a new one, optionally changing the gamemode as well)

'''changemode newgamemode [newmap]''' (changes to a new gamemode, optionally starting a map with it)

'''gamemode newgamemode [newmap]''' (same as previous one)

'''stopmode''' (stops the current mode and mode map)

'''stopmap''' (stops the current mode map)

'''maps [gamemode]''' (lists all maps in the server, optionally all maps compatible with a gamemode)

'''gamemodes''' (lists all gamemodes)

==Settings==
'''*mapmanager.color''' [hex color string] (changes the mapmanager's output messages' color) (default: #E1AA5A)

'''*mapmanager.messages''' [boolean] (whether map/gm changes are enabled) (default: true)

'''*mapmanager.ASE''' [boolean] (whether the manager will set ASE gametype / mapname) (default: true)

==Exported functions==
<syntaxhighlight lang="lua">bool changeGamemode ( resource newGamemode, [ resource mapToLoadWith ] )</syntaxhighlight>
Changes the gamemode to a new one, optionally specifying an initial map for it (will load without a map by default).
<syntaxhighlight lang="lua">bool changeGamemodeMap ( resource newMap, [ resource gamemodeToChangeTo ] )</syntaxhighlight>
Changes the GM map to a new one, optionally specifying a gamemode to change to before loading it (will load with the current gamemode by default).
<syntaxhighlight lang="lua">table getGamemodes ( )</syntaxhighlight>
Returns a table of all gamemode resource pointers.
<syntaxhighlight lang="lua">table getGamemodesCompatibleWithMap ( resource theMap )</syntaxhighlight>
Returns a table of compatible gamemode resource pointers.
<syntaxhighlight lang="lua">table getMaps ( )</syntaxhighlight>
Returns a table of all map resource pointers.
<syntaxhighlight lang="lua">table getMapsCompatibleWithGamemode ( [ resource theGamemode ] )</syntaxhighlight>
Returns a table of compatible map resource pointers. If the gamemode is left blank, it returns all maps which aren't compatible with any gamemode.
<syntaxhighlight lang="lua">resource getRunningGamemode ( )</syntaxhighlight>
Returns the currently running gamemode's resource pointer.
<syntaxhighlight lang="lua">resource getRunningGamemodeMap ( )</syntaxhighlight>
Returns the currently running GM map's resource pointer.
<syntaxhighlight lang="lua">bool isGamemode ( resource theGamemode )</syntaxhighlight>
Determines if a resource is a gamemode or not.
<syntaxhighlight lang="lua">bool isGamemodeCompatibleWithMap ( resource theGamemode, resource theMap )</syntaxhighlight>
Determines if a gamemode is compatible with a map or not.
<syntaxhighlight lang="lua">bool isMap ( resource theMap )</syntaxhighlight>
Determines if a resource is a map or not.
<syntaxhighlight lang="lua">bool isMapCompatibleWithGamemode ( resource theMap, resource theGamemode )</syntaxhighlight>
Determines if a map is compatible with a gamemode or not.
<syntaxhighlight lang="lua">bool stopGamemode ( )</syntaxhighlight>
Stops the current gamemode and its map.
<syntaxhighlight lang="lua">bool stopGamemodeMap ( )</syntaxhighlight>
Stop the current GM map.
Determines if a map is compatible with a gamemode or not.

==Fired events==
''(For all these events, "source" is the resource's root element.)''
<syntaxhighlight lang="lua">onGamemodeStart ( resource startedGamemode )</syntaxhighlight>
Fired before a gamemode starts.
<syntaxhighlight lang="lua">onGamemodeStop ( resource stoppedGamemode )</syntaxhighlight>
Fired before a gamemode is stopped.
<syntaxhighlight lang="lua">onGamemodeMapStart ( resource startedMap )</syntaxhighlight>
Fired before a GM map starts.
<syntaxhighlight lang="lua">onGamemodeMapStop ( resource stoppedMap )</syntaxhighlight>
Fired before a GM map is stopped.

==Supported map settings==
The following settings from the [[settings system|registry]] are applied by the map manager when a map is started:
 '''gamespeed''' [number]: The map's game speed.
 '''gravity''' [number]: The map's gravity.
 '''time''' [string of the form '''hh:mm''']: The map's time.
 '''weather''' [number]: The map's weather ID.
 '''waveheight''' [number]: The map's wave height.
 '''locked_time''' [boolean]: Whether the set time will be frozen by the manager or not.
 '''minplayers''' [number]: The required minimum number of players to start the map.
 '''maxplayers''' [number]: The allowed maximum number of players to start the map.

[[it:Map manager]]
[[ru:Resource:Mapmanager]]