Multi Theft Auto: Wiki - User contributions [en]

RU/Meta.xml

2009-12-13T19:25:25Z

Morozzzko: /* Возможные тэги */

{{translate}}
Этот файл имеет очень важное содержание, которое позволяет загрузить ресурс/режим/карту. Вам нужно указать имена файлов, которые ваш скрипт/режим e (resource) будет использовать в файле '''meta.xml'''. Если вы хотите отображать изображение на экране клиента, клиент должен сначала загрузить его. Чтобы сервер знал, что вы хотите использовать изображение, нужно прописать имя файла в meta.xml. Если вам нужно использовать какие-то настройки для скрипта в качестве переменных, вы можете прописать их в тэге <settings>.

Примечание: Вы можете опробывать простой генератор meta.xml, созданный 50p: http://forum.mtasa.com/viewtopic.php?f=91&t=22247

== Возможные тэги ==
Тэги в .xml такие же, как в . html. Файл meta.xml имеет множество тэгов, необходимых и опциональных. У них есть свои атрибуты.
Язык XML не умеет формировать тэги, он служит как простой способ хранения данных. Интерпретацией тэгов занимаются скрипты, то есть '''вы можете определять новые тэги в XML'''. Однако, MTA определяет несколько тэгов самостоятельно, они приведены ниже:

*'''<info />''' Информация о данном ресурсе, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' Автор
** '''version:''' Версия
** '''name:''' Название
** '''description:''' Описание
** '''type:''' Тип ресурса, может быть "gamemode", "script", "map" or "misc".
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client" or "server"
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "server" and "client")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the LUA interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.

== Example ==
Heres an example of a meta file using some of the tags mentioned:
<syntaxhighlight lang="lua" lang="xml"><meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>

<script src="stealthmain_server.lua" />
<script src="noiseblip.lua" />
<script src="mission_timer.lua" />
<script src="gadgets_server.lua" />
<script src="gadgets_client.lua" type="client"/>
<script src="stealthmain_client.lua" type="client"/>
<script src="noisebar.lua" type="client"/>
<script src="spycam.lua" type="client"/>

<file src="riot_shield.txd" />
<file src="riot_shield.dff" />
<file src="riot_shield.col" />
<file src="armor.png" />
<file src="camera.png" />
<file src="cloak.png" />
<file src="goggles.png" />
<file src="mine.png" />
<file src="radar.png" />
<file src="shield.png" />

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
</settings>
</meta></syntaxhighlight>
[[Category:Scripting Concepts]]
[[Category:Incomplete]]
[[en:Meta.xml]]

Введение в скриптинг GUI

2009-12-09T17:52:36Z

Morozzzko:

Одна из важных особенностей MTA:SA - возможность создания собственного GUI (графический пользовательский интерфейс). Графический интерфейс состоит из окон, кнопок, текстовых полей... Проще говоря, из всех стандартных компонент графических интерфейсов. Они могут использоваться пока пользователь в игре, и использоваться для ввода/вывода вместо команд.

[[Image:AdminGUI.png|thumb|Admin Console GUI]]

==Руководство по созданию интерфейса авторизации==
В этом руководстве мы сделаем простое окно авторизаци с двумя полями ввода и кнопкой. Окно появляется, когда игрок подключается к игре, и после того, как нажата кнопка, игрок респаунится. Это руководство - продолжение предыдущего ([[RU/Scripting Introduction|Введение в скриптинг]]). Теперь мы познакомимся с написанием клиентских скриптов.

===Отрисовка окна===
GUI работает на стороне клиента. Хорошим решением будет поместить все клиентские скрипты в отдельный каталог. Перейдите в каталог /Ваш сервер MTA/mods/deathmatch/resources/myserver/ и создайте подкаталог "client". В нём создайте текстовый файл и назовите его "gui.lua". В этом файле мы напишем функцию, отображающую окно:
<syntaxhighlight lang="lua">
function CreateLoginWindow()
local X = 0.375
local Y = 0.375
local Width = 0.25
local Height = 0.25
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)
end
</syntaxhighlight>
Вы можете кликнуть по имени функции, чтобы прочитать её описание. Заметьте, что координаты окна задаются в ''процентах'' от размеров экрана. Это значит, что левая граница экрана по ширине принимается за 0, а правая за 1, соответственно, "X" равное 0.5 обозначает середину экрана. Аналогично и для позиции по высоте, ширины и высоты окна (если "width" равно 0.5, окно будет в половину ширины экрана). Теперь мы добавим текстовые меткм (с надписями "username:" и "password:"), поля ввода и кнопку. Замените функцию её полной версией:
<syntaxhighlight lang="lua">
function CreateLoginWindow()
local X = 0.375
local Y = 0.375
local Width = 0.25
local Height = 0.25
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)

X = 0.0825
Y = 0.2
Width = 0.25
Height = 0.25
guiCreateLabel(X, Y, Width, Height, "Username", true, wdwLogin)
Y = 0.5
guiCreateLabel(X, Y, Width, Height, "Password", true, wdwLogin)

X = 0.415
Y = 0.2
Width = 0.5
Height = 0.15
edtUser = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
Y = 0.5
edtPass = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
guiEditSetMaxLength(edtUser, 50)
guiEditSetMaxLength(edtPass, 50)

X = 0.415
Y = 0.7
Width = 0.25
Height = 0.2
btnLogin = guiCreateButton(X, Y, Width, Height, "Log In", true, wdwLogin)

guiSetVisible(wdwLogin, false)
end
</syntaxhighlight>
Обратите внимание на то, что каждый компонент интерфейса является дочерним по отношению к окну, это достигается указанием родительского элемента (wdwLogin, в данном случае) при создании элемента:
<syntaxhighlight lang="lua">
guiCreateLabel(X, Y, Width, Height, "Password", true, wdwLogin)
</syntaxhighlight>
Это очень удобно, т.к. в дальнейшем, при отображении окна, можно обращаться только к родительскому элементу. К примеру:
<syntaxhighlight lang="lua">
guiSetVisible(wdwLogin, false) --прячет всё окно целиком так, что мы можем показать его игроку в любой момент.
</syntaxhighlight>

Для редактироования GUI вы также можете воспользоваться [[RU/Resource:GUI_Editor | редактором GUI]].

===Использование написаной нами функции===
Функция CreateLoginWindow написана, но она не будет работать, пока мы её не вызовем. Рекомендуется создавать все окна при запуске ресурса на клиенте, прятать их, и показывать игроку позднее, когда они понадобятся. Для этого напишем обработчик события "[[onClientResourceStart]]", в котором будем создавать окно:
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
CreateLoginWindow()
end
)
</syntaxhighlight>
Мы хотим показывать окно когда клиент подключается к игре, используя то же событие "[[onClientResourceStart]]". Теперь обработчик выглядит так:
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
CreateLoginWindow()

outputChatBox("Welcome to My MTA DM Server, please log in. ")

if (wdwLogin ~= nil) then
guiSetVisible(wdwLogin, true)
end

showCursor(true)
guiSetInputEnabled(true)
end
)
</syntaxhighlight>
Заметьте, что мы выполняем проверку перед показом окна, так, в случае, если окно не создано, не возникнет ошибки. Функция [[showCursor]] включает управление мышью, а [[guiSetInputEnabled]] позволяет быть уверенным, что использование при вводе некоторых клавиш, таких как "A", "S", "D", "W", "T", не приведёт к движению персонажа, или вводу текста в чате. На следующем шаге мы заставим кнопку работать так, как задумывалось.

===Обработчик нажатия кнопки===
Когда пользователь кликает по любому элементу интерфейса, генерируется событие "[[onClientGUIClick]]" для этого элемента. К примеру, если вы кликните по кнопке, можно добавить обработчик для этого события:
<syntaxhighlight lang="lua">
addEventHandler("onClientGUIClick", theButtonElement, theHandlerFunction, false)
</syntaxhighlight>
В нашем скрипте требуется только обработчик привязанный к кнопке. При клике по ней, клиент должен сообщить серверу, что нужно респаунить игрока. Найдите обработчик события "onClientResourceStart" из предыдущей части и добавьте следующую строку сразу ПОСЛЕ вызова CreateLoginWindow() :
<syntaxhighlight lang="lua">
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>
Обработчик должен быть добавлен здесь, чтобы быть уверенным, что переменная btnLogin содержит существующую кнопку. Нельзя привязать событие к несуществующему элементу. Вы, должно быть, заметили, что нам потребуется функция "clientSubmitLogin", вызываемая в предыдущей строке.
<syntaxhighlight lang="lua">
function clientSubmitLogin(button, state)
if (button == "left" and state == "up") then

triggerServerEvent("SubmitLogin", getRootElement(), guiGetText(edtUser), guiGetText(edtPass))
guiSetInputEnabled(false)
guiSetVisible(wdwLogin, false)
showCursor(false)
end
end
</syntaxhighlight>
Переменная "button" передается обработчиком события и содержит строку с именем этой кнопки (к примеру "left" или "right"). Здесь мы познакомились с новой концепцией пользовательских событий. Пользовательские события могут генерироваться как на одной стороне, так и на разных (с сервера на клиент и наоборот). Мы используем функцию [[triggerServerEvent]], чтобы сгенерировать событие "SubmitLogin" на сервере.

Теперь у нас есть весь необходимый клиентский код. На сервере, как вы помните, мы спавним игрока как только он подключается к серверу:
<syntaxhighlight lang="lua">
function joinHandler()
local x,y,z
x = 1959.55
y = -1714.46
z = 10
spawnPlayer(source, x, y, z)
fadeCamera(source, true)
outputChatBox("Welcome to My Server", source)
end
addEventHandler("onPlayerJoin", getRootElement(), joinHandler)
</syntaxhighlight>
Так как теперь мы должны спавнить игрока после нажатия на кнопку, нам нужно заменить событие "onPlayerJoin" пользовательским событием, генерируемым клиентом. Замените приведенный выше код следующим образом:
<syntaxhighlight lang="lua">
function joinHandler(username, password)
local x,y,z
x = 1959.55
y = -1714.46
z = 10
if (client) then
spawnPlayer(client, x, y, z)
fadeCamera(client, true)
outputChatBox("Welcome to My Server", client)
end
end

addEvent("SubmitLogin", true)
addEventHandler("SubmitLogin", getRootElement(), joinHandler)
</syntaxhighlight>
Обратите внимание на второй параметр функции [[addEvent]] (имеющий значение "true"), он указывает, что событие может быть сгенерировано другой стороной. так же заметьте, что "client" - внутренняя переменная, используемая MTA для идентификации игрока, сгенерировавшего событие.

И, наконец, не забудьте добавить файл gui.lua в meta.xml основного ресурса и пометть его как клиентский:
<syntaxhighlight lang="xml">
<script src="client/gui.lua" type="client" />
</syntaxhighlight>

Теперь у нас есть минимальное окно авторизации, спавнящее игрока при нажатии кнопки "login". Вы также можете использовать логин и пароль, передаваемые функцией [[triggerServerEvent]] для идентификации пользователя.

[[en:Introduction_to_Scripting_GUI]]
[[it:Introduzione_allo_scripting_della_GUI]]

IsVehicleTaxiLightOn

2009-12-01T17:01:47Z

Morozzzko: /* Example */

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

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

==Example==
<section name="Client" class="client" show="true">
This example binds the 'o' key to a function that toggles the taxi's light on and off, if you're in a taxi.
<syntaxhighlight lang="lua">
function toggleTaxiLight()
local gamer = getLocalPlayer()
local car = getPedOccupiedVehicle(gamer)
if gamer == getVehicleOccupant(car, 0) then -- if is a driver
local lights = getVehicleTaxiLightOn(car) -- getting vehicle lights state
local id = getElementModel(car) -- getting vehicle model
if ((id == 420) or (id== 438)) then -- if is a taxi
setVehicleTaxiLightOn(car, not lights) -- switch lights
end
end
end

bind("o", "down", toggleTaxiLight) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}

RU/Writing Gamemodes

2009-11-30T13:32:27Z

Morozzzko:

{{translate}}
Это руководство поможет вам, как написать правильный режим игры. Если вы только что начали писать скрипты для MTA, вы должны сначала просмотреть другие учебники на [[RU/Main Page|Главная страница]].
==Введение==
Gamemode (ГМ, мод, гейммод) - ресурс, который, будучи запущенным, контролирует весь игровой процесс. Гейммод включает в себя посылку сообщений игрокам - указания к действиям; респауном игроков; созданием команд; указанием, что игрокам надо делать для победы, или для получения очков, и т.д. Примеры - гонки и DeatMatch'и

==What does "proper gamemode" mean?==
To put it simply, a proper gamemode is one that makes full use of MTA's .map file system. This means that the gamemode code does not have any map-specific data hardcoded in it, like positions of players or cars. Instead, the gamemode should be able to load .map files which define these data. This way the gamemode can have multiple maps; also, people can create .map files for the gamemode with MTA's map editor, which is much more convenient than writing code.

An obvious example of a "proper gamemode" is MTA:Race. It allows usermade maps with lots of possibilities within the .map file. To alter spawnpoints, objects etc., the user doesn't need to edit the gamemode itself.

===Map Files===
Map files are basically XML documents with a .map extension. They define an environment to play one or more specific gamemodes in. They are however not supposed to change the rules of the game - those are defined by the gamemode.

Each element in a map corresponds to a node in the .map file. There is standard syntax for common things like spawnpoints, objects and vehicles; however, for "special", gamemode specific information, you need to invent your own syntax.

====Example====
Let's take a Capture the Flag gamemode as an example. A map for this gamemode needs to mainly define spawnpoints and flag locations, and eventually objects and vehicles. A simplified map file could look like this:
<syntaxhighlight lang="xml">
<map>
<spawnpoint id="spawnpoint1" posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" rot="63.350006103516" model="0"/>
<pickup id="Armor 1" posX="1911.083984375" posY="-1658.8798828125" posZ="885.40216064453" type="armor" health="50" respawn="60000"/>
<flag posX="1959.5487060547" posY="-1714.4613037109" posZ="877.25219726563" team="blue" />
...
</map>
</syntaxhighlight>

Here you can see two MTA elements - a spawnpoint and a pickup. More importantly, this .map has a custom "flag" node which defines the position and color of the flag. The spawnpoint and pickup can be handled by existing external resources, custom elements have to be processed by the gamemode.

To summarize - we want mass mapper input as we saw in MTA:Race. Users should NOT have to touch the gamemode script itself at all.

====Example of getting the .map information====
As mentioned above, your gamemode needs de retrieve custom elements that are defined in a map file and process them. This is quite easy as demonstrated below.
<syntaxhighlight lang="lua">
-- retrieve a table with all flag elements
local flagElements = getElementsByType ( "flag" )
-- loop through them
for key, value in pairs(flagElements) do
-- get our info
local posX = getElementData ( value, "posX" )
local posY = getElementData ( value, "posY" )
local posZ = getElementData ( value, "posZ" )
local team = getElementData ( value, "team" )
-- create an object according to the flag position
createObject ( 1337, posX, posY, posZ )
-- output the team that we created a base for
outputChatBox ( "Base for team " .. team .. " created" )
end
</syntaxhighlight>
The [[getElementsByType]] function retrieves a table of all the elements of a certain type (the type corresponds to the node name in the .map file). This works for both custom types and built-in MTA types (like "vehicle" or "player").
[[getElementData]] can be used to retrieve the xml attributes set in the .map file.
In this simple example, an object is created at the flag's location and a message is outputted in the chatbox. In reality, you will of course need to do more during map loading, like in this case setting up collision shapes to detect players taking the flag.

==Map manager==
Having read the section above it should be clear that a gamemode should always consist of two parts:
* The gamemode resource that always stays the same
* Many different maps resources that give the gamemode map-specific information

Now instead of writing a map-loader for every single gamemode, the [[Map manager]] provides functions to load gamemodes and maps. Simply put, when you enter the correct command (for example 'gamemode ctf ctf-italy') it will start both resources 'ctf' and 'ctf-italy' while triggering an event ([[onGamemodeMapStart]]) to tell the 'ctf' resource that a map was loaded. The 'ctf' resource can then access the information 'ctf-italy' contains and start spawning players etc.

===How to use the mapmanager===
To use the mapmanager service, your gamemode resource has to be tagged as such first. More specifically you'll be setting the "type" attribute of its <info> tag to "gamemode" inside meta.xml. Also, you can set the "name" attribute to a friendly name (like "Capture the flag") that will be shown on ASE instead of the resource name.
<syntaxhighlight lang="xml">

<meta>
<info type="gamemode" name="Cow catapulting 2.0"/>
</meta>
</syntaxhighlight>

If your gamemode is going to load custom maps, you should add handlers for
* onGamemodeMapStart
* onGamemodeMapStop (if any unloading is necessary)
These are fired when a map for your gamemode is started or stopped, and pass the map resource as a parameter.
Within the handler function for these events you can extract all info you need from the resource's map files and configuration files.

====Example====
<syntaxhighlight lang="lua">
function startCtfMap( startedMap ) -- startedMap contains a reference to the resource of the map
local mapRoot = getResourceRootElement( startedMap ) -- get the root node of the started map
local flagElements = getElementsByType ( "flag" , mapRoot ) -- get all flags in the map and store them in a table
-- go on loading information like in the example above

-- spawn players etc.

end

addEventHandler("onGamemodeMapStart", getRootElement(), startCtfMap)
</syntaxhighlight>

===Making maps compatible===
Maps are separate resources. This is done so no editing of the gamemode resource is ever necessary in order to create a custom map, and also allows you to pack map-specific scripts/config files with them.

To make a map compatible with your gamemode, open its resource's meta.xml and tag it as well: the "type" attribute must be set to "map", and the "gamemodes" attribute must be a comma-separated list (no spaces) of gamemode resource names that the map works with.
<syntaxhighlight lang="xml">

<meta>
<info type="map" gamemodes="cowcatapult,assault,tdm"/>
</meta>
</syntaxhighlight>

Once you have everything set up, admins will use these two commands to start/stop gamemodes:
/gamemode gamemodeName [mapName] (optional parameter allows picking an initial map, defaults to none)
/changemap mapName [gamemodeName] (optional parameter specifies the gamemode to start the map with, defaults to the current one)

[[Map manager]] exports a few more access functions which you don't have to use, but may be useful.

==What else should you do==
There are several other resources that gamemodes should use/be compliant with.

===Helpmanager===
The helpmanager is ought to be the standard interface for players when they need help. If you use the helpmanager to display your gamemode's help, every player that used helpmanager before (e.g. in other gamemodes) will immediately know how to get there. It also displays help for different resources running resources in one window, if necessary.

There are basicially two ways to use the helpmanager:
* Provide a simple text that explains how to use your gamemode
* Request a GUI element from the helpmanager that will be displayed in its own tab in the helpmanager window and lets you add any GUI elements to it. This is the recommended way for gamemodes that need to display more complex information that needs its own GUI.

Read the helpmanager page for details on how to do it.

===Scoreboard===
Scoreboard displays players and teams currently ingame. You add custom columns to it to provide map specific information. For example the column 'points' in the 'ctf' gamemode could represent the player's points gained through kills or captures. As usual, see the scoreboard help page for more information.

===Map cycler===
The map cycler controls what gamemodes and maps are played on a server. You can specifiy for example how many times in a row a map will be played until it switches to the next. To achieve this, you need to tell the map cycler when your gamemode finished (e.g. when a round ends).

[[en:Writing Gamemodes]]
[[it:Scrivere una gamemode]]

IsVehicleTaxiLightOn

2009-11-30T12:43:21Z

Morozzzko: /* Example */

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function myfunction()
local player = getLocalPlayer()
local vehicle = getPlayerOccupiedVehicle(player)
if player == getVehicleOccupant(vehicle, 0) then -- if is a driver
local lights = getVehicleTaxiLightOn(vehicle) -- getting vehicle lights state
local id = getElementModel(vehicle) -- getting vehicle model
if ((id == 420) or (id== 438)) then -- if is a taxi
setVehicleTaxiLightOn(vehicle, not lights) -- switch lights
end
end
end

bind("o", "down", myfunction) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}

IsVehicleTaxiLightOn

2009-11-30T12:43:08Z

Morozzzko: /* Example */

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function myfunction()
local player = getLocalPlayer()
local vehicle = getPlayerOccupiedVehicle(player)
if player == getVehicleOccupant(vehicle, 0) then -- if is a driver
local lights = getVehicleTaxiLightOn(vehicle) -- getting vehicle lights state
local id = getElementModel(vehicle) -- getting vehicle model
if ((id == 420) or (id== 438) then -- if is a taxi
setVehicleTaxiLightOn(vehicle, not lights) -- switch lights
end
end
end

bind("o", "down", myfunction) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}

IsVehicleTaxiLightOn

2009-11-30T12:42:39Z

Morozzzko: /* Example */

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function myfunction()
local player = getLocalPlayer()
local vehicle = getPlayerOccupiedVehicle(player)
if player == getVehicleOccupant(vehicle, 0) then -- if is a driver
local lights = getVehicleTaxiLightOn(vehicle) -- getting vehicle model
local id = getElementModel(vehicle)
if ((id == 420) or (id== 438) then -- if is a taxi
setVehicleTaxiLightOn(vehicle, not lights) -- switch lights
end
end
end

bind("o", "down", myfunction) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}

IsVehicleTaxiLightOn

2009-11-30T12:40:36Z

Morozzzko: /* Example */

__NOTOC__
[[Category:Needs_Example]]
{{Server client function}}
This function will get the taxi light state of a taxi (vehicle ID's 420 and 438)

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleTaxiLightOn ( vehicle taxi )
</syntaxhighlight>

===Required Arguments===
*'''taxi:''' The vehicle element of the taxi that you wish to get the light state of.

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

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function myfunction()
local player = getLocalPlayer()
local vehicle = getPlayerOccupiedVehicle(player)
if player == getVehicleOccupant(vehicle, 0) then -- if is a driver
local lights = getVehicleTaxiLightOn(getElementModel(vehicle)) -- getting vehicle model
if ((vehicle == 420) or (vehicle == 438) then -- if is a taxi
setVehicleTaxiLightOn(vehicle, not lights) -- switch lights
end
end
end

bind("o", "down", myfunction) -- binding the function

</syntaxhighlight>
</section>

==See Also==
{{vehicle functions}}