Multi Theft Auto: Wiki - User contributions [en]

SetCameraFieldOfView

2025-10-26T01:04:46Z

Makaveli: /* Required Arguments */

__NOTOC__
{{client function}}
{{New feature/item|3.0151|1.5.1|7397|This function sets the field of view of the ''dynamic camera'' - this is the field of view of the ''non-fixed camera'' - yes, the camera that the user can control whilst on foot or in a vehicle. The higher the field of view angle, the more you will be able to see to your sides.}}
{{Note|This function omits (but doesn't override) the user game option in '''''Settings -> Video -> FOV'''''}}
{{Note|It doesn't affect the FOV for the following camera modes: 1) Player aiming 2) Vehicle front bumper camera 3) Fixed camera}}
==Syntax==
<syntaxhighlight lang="lua">
bool setCameraFieldOfView ( string cameraMode, float fieldOfView [, bool instant = false ] )
</syntaxhighlight>
{{OOP||Camera.setFieldOfView||getCameraFieldOfView}}

===Required Arguments===
'''Note:''' after 100, some unexpected things may happen to the camera, particularly in vehicles, use carefully!
*'''cameraMode:''' the camera mode to set the field of view of:
** "player": whilst walking/running
** "vehicle": whilst in vehicle
** "vehicle_max": the max the field of view can go to when the vehicle is moving at a high speed (must be higher than "vehicle" | the normal difference between "vehicle" and "vehicle_max" is 10)
*'''fieldOfView:''' The field of view angle, 0 to 179.

===Optional arguments===
{{OptionalArg}}
{{New feature/item|3.0161|1.6.0|23300|
*'''instant''': If set to ''true'', the value is applied immediately, without delay (does not work with "vehicle_max").
}}

===Returns===
Returns ''true'' if the arguments are valid, ''false'' otherwise.

==Example==
In this example, the field of view for 'player walking/running' camera is set to 20, once resource fully starts.

<syntaxhighlight lang="lua">
local function changeCameraFovOnClientResourceStart()
setCameraFieldOfView("player", 20)
end
addEventHandler("onClientResourceStart", resourceRoot, changeCameraFovOnClientResourceStart)</syntaxhighlight>

==See Also==
{{Client camera functions}}

[[hu:setCameraFieldOfView]]
[[RO:setCameraFieldOfView]]

OnPlayerTriggerEventThreshold

2025-08-24T13:52:10Z

Makaveli: /* Example */

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22313|This event is triggered when a player exceeds the maximum threshold for events via [[triggerServerEvent]].}}

During each interval (''player_triggered_event_interval''), all usage of [[triggerServerEvent]] will be counted for each player. This includes registered events, non-registered events and non-remote events.

If the count exceeds ''max_player_triggered_events_per_interval'', this event will be fired. The count is reset each interval.

You can set these options via [[setServerConfigSetting]].

==Parameters==
{{New feature/item|3.0161|1.6.0|23281|'''eventName:''' the name of last called event.}}

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who exceeded the threshold.

===Canceling===
Canceling this event has no effect.

==Example==
<syntaxhighlight lang="lua">
function processPlayerTriggerEventThreshold(eventName)
kickPlayer(source, "Event spam | Event name: " .. eventName)
end
addEventHandler("onPlayerTriggerEventThreshold", root, processPlayerTriggerEventThreshold)

</syntaxhighlight>
{{See also/Server event|Player events}}

GetElementsByType

2025-07-12T19:30:58Z

Makaveli: /* Required Arguments */

{{Server_client_function}}
__NOTOC__
This function is used to retrieve a list of all elements of the specified type. This can be useful, as it disregards ''where'' in the element tree it is. It can be used with either the built in types (listed below) or with any custom type used in a .map file. For example, if there is an element of type "flag" (e.g. <flag />) in the .map file, the using "flag" as the type argument would find it.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getElementsByType ( string theType, [ element startat=getRootElement() ] )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
table getElementsByType ( string theType, [ element startat=getRootElement(), bool streamedIn=false ] )
</syntaxhighlight>
</section>

{{OOP|This function is a static function underneath the Element class.|[[Element]].getAllByType||}}

===Required Arguments===
*'''theType:''' The type of element you want a list of. This is the same as the tag name in the .map file, so this can be used with a custom element type if desired. Built in types can be found here: [[Element]]
**'''"player":''' A player connected to the server
**'''"ped":''' A ped
**'''"water":''' A water polygon
**'''"sound":''' A playing sound
**'''"vehicle":''' A vehicle
**'''"object":''' An object
**'''"pickup":''' A pickup
**'''"marker":''' A marker
**'''"colshape":''' A collision shape
**'''"blip":''' A blip
**'''"radararea":''' A radar area
**'''"team":''' A team
**'''"spawnpoint":''' A spawnpoint
**'''"console":''' The server Console
**'''"projectile":''' A clientside projectile
**'''"effect":''' A clientside effect
**'''"light":''' A clientside light
**'''"searchlight":''' A clientside searchlight
**'''"shader":''' A shader
**'''"texture":''' A texture
**'''"gui-window":''' A GUI window (there's others like this for other GUI types)
**'''"building":''' A building (client side only)
**'''"resource":''' All the loaded resources

==Optional Arguments==
{{OptionalArg}}
*'''startat:''' The [[element]] the search should start at. Children of this element are searched, siblings or parents will not be found. By default, this is the root element which should suit most uses.

<section name="Client" class="client" show="true">
*'''streamedIn:''' If true, function will only return elements that are streamed in.
</section>

===Returns===
Returns a ''table'' containing all the elements of the specified type. Returns an empty ''table'' if there are no elements of the specified type. Returns ''false'' if the string specified is invalid (or not a string).

==Example==
'''Example 1:''' This example retrieves a table of the players in the server, and checks whether or not each one is in a vehicle:
<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
if ( isPlayerInVehicle ( thePlayer ) ) then -- if the player is in a vehicle, announce it
outputChatBox ( getPlayerName ( thePlayer ) .. " is in a vehicle" )
else -- if the player isn't in a vehicle, announce that he/she is on foot
outputChatBox ( getPlayerName ( thePlayer ) .. " is on foot" )
end
end
</syntaxhighlight>

'''Example 2:''' This example retrieves a table of the teams in the server, and display them in chat:
<syntaxhighlight lang="lua">
local teams = getElementsByType("team")
for i,team in ipairs(teams) do
local teamName = getTeamName(team) -- get the team name
outputChatBox(teamName) -- display the team name in chat
end
</syntaxhighlight>

'''Example 3:''' This shows how you could create a new element to describe a gas station:
<syntaxhighlight lang="lua">
function createGasStations(below)
local gasstations = getElementsByType ( "gasstation", below ) -- get a table of all the gas station elements in the element tree
for theKey,theGasStation in ipairs(gasstations) do
local x = getElementData(theGasStation, "posX") -- get the position of the element
local y = getElementData(theGasStation, "posY")
local z = getElementData(theGasStation, "posZ")
setElementParent(createColSphere(x, y, z, 10), theGasStation) -- create a colshape for the gas station at the gas station's position
addEventHandler("onColShapeHit", theGasStation, giveGas) -- when the player hits
end
end

function mapLoad()
createGasStations(source) -- create gas stations for the map that's just loaded
end
addEventHandler("onResourceStart", resourceRoot, mapLoad)

function giveGas(hittingElement)
local theGasStation = source
if getElementType(hittingElement) == "vehicle" then
local gas_left = getElementData(theGasStation, "amount")
local gas_speed = getElementData(theGasStation, "speed")
if gas_left > 0 then

local gas_to_remove = gas_speed
if gas_left < gas_speed then
gas_to_remove = gas_left

local current_vehicle_gas = getElementData(hittingElement, "gas")
current_vehicle_gas = current_vehicle_gas + gas_to_remove
gas_left = gas_left - gas_to_remove

setElementData(hittingElement, "gas", current_vehicle_gas)
setElementData(theGasStation, "amount", gas_left)
else
outputChatBox("Pump is out of gas!")
end
end
end
</syntaxhighlight>

'''Example 4:''' This example loops trough all connected players and redirects them to another server host:
<syntaxhighlight lang="lua">
local serverIP = "99.88.77.66" -- Change to your server IP to redirect everyone
local serverPort = 22005 -- The destination server's port

function redirectAllPlayers()
for _,p in ipairs (getElementsByType("player")) do
if p then
redirectPlayer (p, serverIP, serverPort)
end
end
end
addEventHandler ("onResourceStart", resourceRoot, redirectAllPlayers)
</syntaxhighlight>

==See Also==
{{Element_functions}}

SetElementOnFire

2025-01-09T18:21:42Z

Makaveli: /* Example */

__NOTOC__
{{Shared function}}
{{New feature/item|3.0161|1.6.0|22864|
This function can be used to set a [[element]] on fire or extinguish a fire on it. Supported types are [[ped]], [[vehicle]] and [[object]].}}

{{Note|Function on the client side only works on elements created on the client side.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementOnFire ( element theElement, bool isOnFire )
</syntaxhighlight>
{{OOP||[[element]]:setOnFire|onFire|isElementOnFire}}

===Required Arguments===
*'''theElement:''' The [[element]] that we want to set/unset.
*'''isOnFire:''' ''true'' to set the [[element]] on fire, ''false'' to extinguish any fire on it.

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

==Examples==
<section name="Server" class="server" show="true">
'''Example 1:''' This example defines a command handler for the command ''fireelement''. This will fire up a player or their vehicle if the state is true. Otherwise the fire will be gone.
<syntaxhighlight lang="lua">
local stringToBoolean = {
["true"] = true,
["false"] = false
}

addCommandHandler("fireelement",
function(sourcePlayer, commandName, fireState)
-- if the player didn't complete the command.
if not (fireState) then
local text = string.format("[Usage]: #FFFFFF/%s [%s]", commandName, "State")

return outputChatBox(text, sourcePlayer, 255, 100, 100, true)
end

-- the state will automatically be a string so we change it to boolean.
local fireState = stringToBoolean[fireState]

-- if the state isn't boolean then we return it.
if type(fireState) ~= "boolean" then
return outputChatBox("[Error]: #FFFFFFThe state has to be true or false.", sourcePlayer, 255, 100, 100, true)
end

local playerVehicle = getPedOccupiedVehicle(sourcePlayer)

if playerVehicle then -- if the player is in a vehicle
setElementOnFire(playerVehicle, fireState)
else -- if the player is not in a vehicle
setElementOnFire(sourcePlayer, fireState)
end
end, false, false
)
</syntaxhighlight>
</section>

==See Also==
{{Element functions}}