Multi Theft Auto: Wiki - User contributions [en]

Help:Adding Pages to Categories and Templates

2015-02-12T19:55:45Z

Walman10: /* Questions? */

==Introduction==
Did you create a new page, such as a function, and it isn't showing up in a list? Did you try and edit it in only to see <nowiki>{{weird_tags_like_this}}</nowiki> instead of text relating to the page you viewed? Welcome to the world of templates. We have noticed in [[Special:RecentChanges|RecentChanges]] that people are making pages and not linking to them properly. '''These pages are being lost in the bowels of the Wiki!'''

We also use categories in this wiki, but they are not as crucial as templates. Please read on to learn about both and to understand how to contribute to our wiki properly.

=Template=
===What is a Template===
It is like a big copy paste on a clipboard. You write a template tag on another page and it writes everything that was on the template page.

*'''Why Use Templates?'''
It allows the same information to be represented in multiple places, without duplicating texts and updating them manually numerous times.

*'''Example?'''
Look at the page source (edit button) on our functions or event pages. You can see that the functions aren't actually listed there, each function group has its own template. The main use for this is to fill out the "See Also" section of individual functions with their related functions.

===How Do You Make/Edit/Use a Template?===

The best way to teach is by example. I will need a template to direct people to this guide from multiple pages in the wiki. Let's just create this template together! FUN!

====1. Choosing a Template Name====
The best template name explains what it is. Typically the best thing is to make the template URL identical to the actual page. Therefore I am going to use:

<pre>http://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates</pre>

'''IMPORTANT:''' Remember that all wiki pages are case sensitive. The same page can exist in uppercase and lowercase! Capitalize appropriately.

If I tried to link to a template that doesn't exist this happens:
{{link_to_nonexistant_template_click_here_to_create_lazypants0}}

So as you can see, it is better we create the template before attempting to link to it!

====2. Filling out the Template====

At the template page, hit create page, and you'll see the edit field box. Type in whatever you need to be said in other pages and save the page. It could be simple text, links to a set of functions, or even as advanced as a bit of code that determines something, such as our future functions template. If you were trying to add to our functions/events then you would just edit a link to your function into the template. Don't screw it up or I will be disappointed in you!

From this point, you use the template page name as a tag inside the pages where you want to use it. My template tag is:

<pre>{{Adding_Pages_to_Categories_and_Templates}}</pre>

====3. Demonstration====
So here I will actually link to the template. If you check the template page source, you will see exactly what is printed below:

{{Adding_Pages_to_Categories_and_Templates}}

'''Note:''' The easiest way to reach a template that was used on a page is to edit the page and scroll to the bottom. A list of all templates used will appear with links to the template pages. For something like the main function pages you have to edit the ENTIRE page to see templates used at the bottom, they do not appear if you only edit a section.

=Category=
===What is a Category===
Categories group pages together. The categories have their own special page where all the grouped pages are alphabetized. Think of them like sorting the Wiki into folders for common pages. For example here is a link to the server functions category page: [[:Category:Server_functions]]

===How do I Make/Edit/Use Categories===
A page is put into a category by editing the following syntax into a page:
<pre>[[:Category:pagename]]</pre>

You do need to create the category page just as you would a template. Again, you simply go to the URL of the category page you want to make. The format is:
<pre>http://wiki.multitheftauto.com/index.php?title=Category:Page_Name_Here</pre>

For the category page itself, you simply write a small explanation what the category (folder) is about.

If you look at the source of the pages listed in [[:Category:Server_functions]], you may notice that the category tag is not in them! It actually is there, but it is being applied through the clever combination of a template with the category embedded.

Those nice colored stripes you see at the tops of pages are all templates that have a category tag embedded. This was designed to make it hard for people to mess-up categories. For example, look at the page source for the blue stripe that says "Client and Server Function" http://wiki.multitheftauto.com/index.php?title=Template:Server_client_function&action=edit

===Demonstration===
I have put a category tag in this page. This is reflected at the very bottom of the page you are reading right now. The category page just happens to be the exact same name. Unlike templates, it is not typical to name the category after a page. They are more like folder names. This is just for demonstration however.

The category page is here: [[:Category:Adding_Pages_to_Categories_and_Templates]]

[[Category:Adding_Pages_to_Categories_and_Templates]]

=More Info=
===Lists of Templates and Categories===
Looking for template and category listings? This is one thing [[Special:SpecialPages|SpecialPages]] is for.

'''Templates:'''
*[[Special:UncategorizedTemplates]]
:Templates not organized into templates (ie think of categories as folders).
*[[Special:UnusedTemplates]]
:Unused templates
*[[Special:WantedTemplates]]
:Tags are linked to this template, but the page itself doesn't exist. It still works de facto. You need to hit create on the template page.
*[[Special:MostLinkedTemplates]]
:Templates that were tagged in the most pages

'''Categories:'''
*[[Special:Categories]]
:All categories overview.
*[[Special:UncategorizedCategories]]
:Categories not within another category (ie not used as subfolders of folders).
*[[Special:UnusedCategories]]
:Unused categories
*[[Special:WantedCategories]]
:Tags are linked to this category, but the page itself doesn't exist. It still works de facto. You need to hit create on the category page.
*[[Special:MostLinkedCategories]]
:Categories that were tagegd in the most places

===Further Reference===
http://en.wikipedia.org/wiki/Help:Template<br>
http://en.wikipedia.org/wiki/Help:Category

===See Also===
[[MTA_Wiki:Editing_Guidelines]] - This is a complete overview of how we use Wiki for MTA, this was only part of it. Please read this!

===Questions?===
Best way to discuss wiki is live on IRC. See the community box on the [[Main Page]] for more info.

[[Category:MTA Wiki:Editing]]
[[Category:Tutorial]]

Help:Adding Pages to Categories and Templates

2015-02-12T19:55:32Z

Walman10: /* Questions? */

==Introduction==
Did you create a new page, such as a function, and it isn't showing up in a list? Did you try and edit it in only to see <nowiki>{{weird_tags_like_this}}</nowiki> instead of text relating to the page you viewed? Welcome to the world of templates. We have noticed in [[Special:RecentChanges|RecentChanges]] that people are making pages and not linking to them properly. '''These pages are being lost in the bowels of the Wiki!'''

We also use categories in this wiki, but they are not as crucial as templates. Please read on to learn about both and to understand how to contribute to our wiki properly.

=Template=
===What is a Template===
It is like a big copy paste on a clipboard. You write a template tag on another page and it writes everything that was on the template page.

*'''Why Use Templates?'''
It allows the same information to be represented in multiple places, without duplicating texts and updating them manually numerous times.

*'''Example?'''
Look at the page source (edit button) on our functions or event pages. You can see that the functions aren't actually listed there, each function group has its own template. The main use for this is to fill out the "See Also" section of individual functions with their related functions.

===How Do You Make/Edit/Use a Template?===

The best way to teach is by example. I will need a template to direct people to this guide from multiple pages in the wiki. Let's just create this template together! FUN!

====1. Choosing a Template Name====
The best template name explains what it is. Typically the best thing is to make the template URL identical to the actual page. Therefore I am going to use:

<pre>http://wiki.multitheftauto.com/index.php?title=Template:Adding_Pages_to_Categories_and_Templates</pre>

'''IMPORTANT:''' Remember that all wiki pages are case sensitive. The same page can exist in uppercase and lowercase! Capitalize appropriately.

If I tried to link to a template that doesn't exist this happens:
{{link_to_nonexistant_template_click_here_to_create_lazypants0}}

So as you can see, it is better we create the template before attempting to link to it!

====2. Filling out the Template====

At the template page, hit create page, and you'll see the edit field box. Type in whatever you need to be said in other pages and save the page. It could be simple text, links to a set of functions, or even as advanced as a bit of code that determines something, such as our future functions template. If you were trying to add to our functions/events then you would just edit a link to your function into the template. Don't screw it up or I will be disappointed in you!

From this point, you use the template page name as a tag inside the pages where you want to use it. My template tag is:

<pre>{{Adding_Pages_to_Categories_and_Templates}}</pre>

====3. Demonstration====
So here I will actually link to the template. If you check the template page source, you will see exactly what is printed below:

{{Adding_Pages_to_Categories_and_Templates}}

'''Note:''' The easiest way to reach a template that was used on a page is to edit the page and scroll to the bottom. A list of all templates used will appear with links to the template pages. For something like the main function pages you have to edit the ENTIRE page to see templates used at the bottom, they do not appear if you only edit a section.

=Category=
===What is a Category===
Categories group pages together. The categories have their own special page where all the grouped pages are alphabetized. Think of them like sorting the Wiki into folders for common pages. For example here is a link to the server functions category page: [[:Category:Server_functions]]

===How do I Make/Edit/Use Categories===
A page is put into a category by editing the following syntax into a page:
<pre>[[:Category:pagename]]</pre>

You do need to create the category page just as you would a template. Again, you simply go to the URL of the category page you want to make. The format is:
<pre>http://wiki.multitheftauto.com/index.php?title=Category:Page_Name_Here</pre>

For the category page itself, you simply write a small explanation what the category (folder) is about.

If you look at the source of the pages listed in [[:Category:Server_functions]], you may notice that the category tag is not in them! It actually is there, but it is being applied through the clever combination of a template with the category embedded.

Those nice colored stripes you see at the tops of pages are all templates that have a category tag embedded. This was designed to make it hard for people to mess-up categories. For example, look at the page source for the blue stripe that says "Client and Server Function" http://wiki.multitheftauto.com/index.php?title=Template:Server_client_function&action=edit

===Demonstration===
I have put a category tag in this page. This is reflected at the very bottom of the page you are reading right now. The category page just happens to be the exact same name. Unlike templates, it is not typical to name the category after a page. They are more like folder names. This is just for demonstration however.

The category page is here: [[:Category:Adding_Pages_to_Categories_and_Templates]]

[[Category:Adding_Pages_to_Categories_and_Templates]]

=More Info=
===Lists of Templates and Categories===
Looking for template and category listings? This is one thing [[Special:SpecialPages|SpecialPages]] is for.

'''Templates:'''
*[[Special:UncategorizedTemplates]]
:Templates not organized into templates (ie think of categories as folders).
*[[Special:UnusedTemplates]]
:Unused templates
*[[Special:WantedTemplates]]
:Tags are linked to this template, but the page itself doesn't exist. It still works de facto. You need to hit create on the template page.
*[[Special:MostLinkedTemplates]]
:Templates that were tagged in the most pages

'''Categories:'''
*[[Special:Categories]]
:All categories overview.
*[[Special:UncategorizedCategories]]
:Categories not within another category (ie not used as subfolders of folders).
*[[Special:UnusedCategories]]
:Unused categories
*[[Special:WantedCategories]]
:Tags are linked to this category, but the page itself doesn't exist. It still works de facto. You need to hit create on the category page.
*[[Special:MostLinkedCategories]]
:Categories that were tagegd in the most places

===Further Reference===
http://en.wikipedia.org/wiki/Help:Template<br>
http://en.wikipedia.org/wiki/Help:Category

===See Also===
[[MTA_Wiki:Editing_Guidelines]] - This is a complete overview of how we use Wiki for MTA, this was only part of it. Please read this!

===Questions?===
Best way to discuss wiki is live on IRC. See the community box on the [[Main Page]] for more info. test

[[Category:MTA Wiki:Editing]]
[[Category:Tutorial]]

BindControlKeys

2014-11-14T13:28:10Z

Walman10: /* See also */

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
These useful clientside functions bind the keys bound to a control individually, using [[bindKey]], and unbind them using [[unbindKey]]. The objective of these functions is to bypass the limitation of binding a control directly which ignores key presses if the control is deactivated at the moment (so the script would be able to react if the player presses ''aim_weapon'' in a vehicle, for example).

==Syntaxes==
<syntaxhighlight lang="lua">boolean/nil bindControlKeys ( string control, misc bindData )</syntaxhighlight>
<syntaxhighlight lang="lua">boolean/nil unbindControlKeys ( string control )</syntaxhighlight>

===Required arguments===
*'''control:''' The name of the control to bind or unbind. See [[control names]].
*'''bindData:''' (''bindControlKeys'' only) Configures how the control keys will be bound. See clientside [[bindKey]] syntaxes for reference.

===Returns===
These functions return ''true'' if no error arised. They return ''nil'' plus an error message otherwise.

==Restrictions==
'''You can only have one control keys bind per control'''. That should be enough for most scripts. If you want to create more binds, copy these functions into a new script file (or [[resource]]) and mark them as ''local''.

==Functions source==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">local controls = { "fire", "next_weapon", "previous_weapon", "forwards", "backwards", "left", "right", "zoom_in", "zoom_out",
"change_camera", "jump", "sprint", "look_behind", "crouch", "action", "walk", "aim_weapon", "conversation_yes", "conversation_no",
"group_control_forwards", "group_control_back", "enter_exit", "vehicle_fire", "vehicle_secondary_fire", "vehicle_left", "vehicle_right",
"steer_forward", "steer_back", "accelerate", "brake_reverse", "radio_next", "radio_previous", "radio_user_track_skip", "horn", "sub_mission",
"handbrake", "vehicle_look_left", "vehicle_look_right", "vehicle_look_behind", "vehicle_mouse_look", "special_control_left", "special_control_right",
"special_control_down", "special_control_up" }

local boundControlsKeys = {}
local bindsData = {}

function unbindControlKeys(control)
-- Ensure the argument has got the appropiate type
assert(type(control) == "string", "Bad argument @ unbindControlKeys [string expected, got " .. type(control) .. "]")
-- Check if we have a valid control
local validControl
for _, controlComp in ipairs(controls) do
if control == controlComp then
validControl = true
break
end
end
assert(validControl, "Bad argument @ unbindControlKeys [Invalid control name]")
-- Have we got a bind on this control?
assert(boundControlsKeys[control], "Bad argument @ unbindControlKeys [There is no bind on such control]")
-- Unbind each key of the control
for _, bindData in pairs(bindsData[control]) do
unbindKey(unpack(bindData))
end
-- Remove references
boundControlsKeys[control] = nil
bindsData[control] = nil
return true
end

function bindControlKeys(control, ...)
-- Ensure the argument has got the appropiate type
assert(type(control) == "string", "Bad argument 1 @ bindControlKeys [string expected, got " .. type(control) .. "]")
-- Check if we have a valid control
local validControl
for _, controlComp in ipairs(controls) do
if control == controlComp then -- Is the specified control in the table?
validControl = true -- If so, it's a valid control
break
end
end
assert(validControl, "Bad argument 1 @ bindControlKeys [Invalid control name]")
-- Do we already have this control bound?
if boundControlsKeys[control] then
unbindControlKeys(control) -- Delete the first control keys bind
end
boundControlsKeys[control] = getBoundKeys(control) -- Store the keys of that control that will be bound
bindsData[control] = {} -- Store bind data, so we can unbind each key of the control later
for key in pairs(boundControlsKeys[control]) do
-- Can we bind the key with the specified arguments?
assert(bindKey(key, unpack(arg)), "Bad arguments @ bindControlKeys [Could not create key bind]")
-- If so, register the bind data and continue
table.insert(bindsData[control], { key, unpack(arg) })
end
return true
end

-- The keys bound to a control can be changed in Settings. The next function updates the binds properly in that case.
-- Also note that the next function IS NOT MEANT to be exported or called by the script.
local function keepControlKeyBindsAccurate()
if next(boundControlsKeys) then -- Have we got any control keys bound?
for boundControl, boundKeys in pairs(boundControlsKeys) do
if toJSON(boundKeys) ~= toJSON(getBoundKeys(boundControl)) then -- Have we changed the keys bound to a control?
-- Update our custom control bind
for _, bindData in ipairs(bindsData[boundControl]) do
unbindKey(unpack(bindData)) -- Unbind every key of that cotnrol that we have bound before
-- Bind again the appropiate keys
for key in pairs(getBoundKeys(boundControl)) do
local bindDataNoKey = bindData -- Copy bindData into another variable
table.remove(bindDataNoKey, 1) -- Ignore the key of our bindData
bindKey(key, unpack(bindDataNoKey)) -- Bind again the data, but with the updated key
bindData[1] = key -- Update the key in the references
end
end
boundControlsKeys[boundControl] = getBoundKeys(boundControl) -- Update the control bound keys list
end
end
end
end
addEventHandler("onClientRender", root, keepControlKeyBindsAccurate)</syntaxhighlight>
</section>

==Example==
This example allows players to toggle driveby by pressing or releasing the ''aim_weapon'' control.
<syntaxhighlight lang="lua">local function toggleDriveby()
if isPedInVehicle(localPlayer) then
setPedDoingGangDriveby(localPlayer, not isPedDoingGangDriveby(localPlayer))
end
end
bindControlKeys("aim_weapon", "both", toggleDriveby)</syntaxhighlight>

== See also ==
{{Useful_Functions}}