Multi Theft Auto: Wiki - User contributions [en]

SetElementDimension

2017-02-28T22:30:11Z

Zneext: Add note about the -1 parameter.

{{Server client function}}
__NOTOC__
This function allows you to set the [[dimension]] of any element. The dimension determines what/who the element is visible to.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementDimension ( element theElement, int dimension )
</syntaxhighlight>
{{OOP||[[element]]:setDimension|dimension|getElementDimension}}

===Required Arguments===
*'''theElement:''' The element in which you'd like to set the dimension of.
*'''dimension:''' An integer representing the dimension ID. {{New feature/item|3.0154|1.5.3|11199|You can also use '''-1''' to make the element visible in all dimensions (only valid to objects).}}

===Returns===
Returns ''true'' if '''theElement''' and '''dimension''' are valid, ''false'' otherwise.
Also returns false if '''theElement''' is a player and it's not alive.

==Example==
<section name="Server" class="server" show="true">
In this example the player's dimension is set to ID 1 when they enter a vehicle, and set back to dimension 0 when they exit the vehicle.
<syntaxhighlight lang="lua">
function onPlayerEnterVehicle ( theVehicle, seat, jacked )
if ( getElementDimension ( source ) == 0 ) then -- if the player is in dimension 0
setElementDimension ( source, 1 ) -- set his dimension to 1
setElementDimension ( theVehicle, 1 ) -- set his vehicle's dimension to 1 as well
end
end
addEventHandler ( "onPlayerVehicleEnter", root, onPlayerEnterVehicle )

function onPlayerExitVehicle ( theVehicle, seat, jacker )
if ( getElementDimension ( source ) == 1 ) then -- if the player is in dimension 1
setElementDimension ( source, 0 ) -- set his dimension back to 0
setElementDimension ( theVehicle, 0 ) -- set his vehicle's dimension back to 0 as well
end
end
addEventHandler ( "onPlayerVehicleExit", root, onPlayerExitVehicle )
</syntaxhighlight>
</section>

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

[[de:setElementDimension]]

Template:Server functions

2016-10-09T15:00:55Z

Zneext: Add getCommandHandlers to the list

*[[addCommandHandler]]
*[[executeCommandHandler]]
*[[fromJSON]]
*[[getFPSLimit]]
*[[getMaxPlayers]]
*[[getServerHttpPort]]
*[[getServerName]]
*[[getServerPassword]]
*[[getServerPort]]
*[[getVersion]]
*[[getCommandHandlers]]
*[[isGlitchEnabled]]
*[[outputChatBox]]
*[[outputConsole]]
*[[outputDebugString]]
*[[outputServerLog]]
*[[removeCommandHandler]]
*[[setFPSLimit]]
*[[setGlitchEnabled]]
*[[setMaxPlayers]]
*[[setServerPassword]]
*[[showChat]]
*[[shutdown]]
*[[toJSON]]

GetCommandHandlers

2016-10-09T14:54:07Z

Zneext: /* Syntax */

{{Server function}}
__NOTOC__
This function is used to retrieve a list of all the registered command handlers of a given resource (or of all resources).

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
table getCommandHandlers ( [ resource theResource ] )
</syntaxhighlight>

==Optional Arguments==
*'''theResource:''' The resource from which you wish to retrieve all command handlers. Or leave it empty to retrieve command handlers of all resources.
</section>

===Returns===
Returns a ''table'' containing all the commands of the given resource or a table with subtables containing the command and theResource pointer ( { "command", theResource } ). See examples below if you don't understand it.

==Example==
<section class="server" name="Server" show="true">
This example add a command to output list of all commands in the chat.
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function(player)
local commandsList = {} --table to store commands

--store/sort commands in the table where key is resource and value is table with commands
for _, subtable in pairs( getCommandHandlers() ) do
local commandName = subtable[1]
local theResource = subtable[2]

if not commandsList[theResource] then
commandsList[theResource] = {}
end

table.insert( commandsList[theResource], commandName )
end

--output sorted information in the chat
for theResource, commands in pairs( commandsList ) do
local resourceName = getResourceInfo( theResource, "name" ) or getResourceName( theResource ) --try to get full name, if no full name - use short name
outputChatBox( "== "..resourceName.. " ==", player, 0, 255, 0 )

--output list of commands
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
end
)
</syntaxhighlight>
</section>

<section class="server" name="Server" show="true">
This example add a command to output list of all commands for the resource in the chat. Syntax: /commands [resource-name]
<syntaxhighlight lang="lua">
addCommandHandler( "commands",
function( player, _, resourceName )
if not resourceName then
resourceName = ""
end

local theResource = getResourceFromName( resourceName )

if not theResource then
outputChatBox( "Can't find resource with name \"" .. resourceName .. "\".", player, 255, 0, 0 )
return false
end

outputChatBox( "== Commands from \""..resourceName.. "\" resource ==", player, 0, 255, 0 )

local commands = getCommandHandlers( theResource )
for _, command in pairs( commands ) do
outputChatBox( "/"..command, player, 255, 255, 255 )
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}