Multi Theft Auto: Wiki - User contributions [en]

SetServerConfigSetting

2022-01-04T17:54:50Z

Haron4igg:

__NOTOC__
{{Server function}}
This function sets server settings which are stored in the [[Server mtaserver.conf|mtaserver.conf]] file.
{{Note|This function is protected by default and must be explicitly allowed in the servers acl before it can be used.}}
{{Warning|"bandwidth_reduction" set to 'maximum' will cause player movement synchronization issues, on locations built outside 3000m radius from world center.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setServerConfigSetting ( string name, string value [, bool bSave = false ] )
</syntaxhighlight>

===Required Arguments===
*'''name :''' The name of the setting. Only certain settings from [[Server mtaserver.conf|mtaserver.conf]] can be changed with this function. These are:
** minclientversion
** recommendedclientversion
** password
** fpslimit - (0-100)
** networkencryption - 0 for off, 1 for on
** bandwidth_reduction - "none", "medium", "maximum" Set to maximum for less bandwidth usage (medium is recommended for race servers)
** player_sync_interval - See [[Sync_interval_settings]] for all *_sync_interval settings
** lightweight_sync_interval
** camera_sync_interval
** ped_sync_interval
** unoccupied_vehicle_sync_interval
** keysync_mouse_sync_interval
** keysync_analog_sync_interval
** bullet_sync
*'''value:''' The value of the setting

===Optional Arguments===
*'''bSave:''' Set to ''true'' to make the setting permanent, or ''false'' for use only until the next server restart.

===Returns===
Returns ''true'' if the setting was successfully set, or ''false'' otherwise.

==Example==
This example enables network encryption
<syntaxhighlight lang="lua">
setServerConfigSetting( "networkencryption", "1", true )
</syntaxhighlight>

==See Also==
{{Utility functions}}

SetServerConfigSetting

2021-12-25T20:12:04Z

Haron4igg:

__NOTOC__
{{Server function}}
This function sets server settings which are stored in the [[Server mtaserver.conf|mtaserver.conf]] file.
{{Note|This function is protected by default and must be explicitly allowed in the servers acl before it can be used.}}
{{Warning|"bandwidth_reduction" set to 'maximum' will cause player movement synchronization issues, on locations built 'above the sky'.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setServerConfigSetting ( string name, string value [, bool bSave = false ] )
</syntaxhighlight>

===Required Arguments===
*'''name :''' The name of the setting. Only certain settings from [[Server mtaserver.conf|mtaserver.conf]] can be changed with this function. These are:
** minclientversion
** recommendedclientversion
** password
** fpslimit - (0-100)
** networkencryption - 0 for off, 1 for on
** bandwidth_reduction - "none", "medium", "maximum" Set to maximum for less bandwidth usage (medium is recommended for race servers)
** player_sync_interval - See [[Sync_interval_settings]] for all *_sync_interval settings
** lightweight_sync_interval
** camera_sync_interval
** ped_sync_interval
** unoccupied_vehicle_sync_interval
** keysync_mouse_sync_interval
** keysync_analog_sync_interval
** bullet_sync
*'''value:''' The value of the setting

===Optional Arguments===
*'''bSave:''' Set to ''true'' to make the setting permanent, or ''false'' for use only until the next server restart.

===Returns===
Returns ''true'' if the setting was successfully set, or ''false'' otherwise.

==Example==
This example enables network encryption
<syntaxhighlight lang="lua">
setServerConfigSetting( "networkencryption", "1", true )
</syntaxhighlight>

==See Also==
{{Utility functions}}

Compiling MTASA

2021-12-11T20:00:54Z

Haron4igg: Improved instructions ower initial compilation of project.

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.

== Prerequisites ==

Compiling the Multi Theft Auto client is only supported on Windows 10.

Make sure you have the following software and SDKs installed:

=== Visual Studio 2022 ===
[[File:Visual_Studio_Community.PNG|right|150px|link=https://www.visualstudio.com/vs/]]
# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2022]''' - make sure you get the Community Edition, that one is free.
# On the installation checklist, [[:File:VsFoundationClasses.png|make sure you tick these 2 items]]:
## ''Desktop development with C++''
## Optional component ''C++ MFC for latest v143 build tools (x86 & x64)''

If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.

If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

=== Microsoft DirectX SDK ===
[[File:DirectX_SDK.jpg|right|150px|link=http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
'''Download Microsoft DirectX SDK (August 2009) (DXSDK_Aug09.exe):'''
* [https://archive.org/download/dxsdk_aug09/DXSDK_Aug09.exe Mirror 1]
* [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe Mirror 2]

{| class="wikitable" style="margin-top: 0px; width: 70%; word-break: break-all;"
|+ File verification
|- style="vertical-align:bottom;"
! colspan="2" | Algorithm and variant
! Hash
! Hash file
|- style="text-align:center;vertical-align:center;"
| rowspan="6" | '''{{nowrap|SHA-3}}''' || ''SHA3-224'' || 8bfcdc03518d7edd34689534fd4d21291469ff2f2eb10437ad648c58 || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha3-224 DXSDK_Aug09.exe.sha3-224]
|- style="text-align:center;vertical-align:center;"
| ''SHA3-256'' || 45bf3e08da3b3636ddb4f4a74243430f8d65759c074c0d79756ef810c4701c5a || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha3-256 DXSDK_Aug09.exe.sha3-256]
|- style="text-align:center;vertical-align:center;"
| ''SHA3-384'' || b358e529963d6f5fd7f8bd4b530fb18f6a2e6a442009a54e981b2f9967589ed48150af310f283640d56f9b60d41100c9 || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha3-384 DXSDK_Aug09.exe.sha3-384]
|- style="text-align:center;vertical-align:center;"
| ''SHA3-512'' || 43522187053af744250059ef69c0f3083cecd1157fe56daac16b9497ebc6fb5b525875144e42898367c55f757cffd3526f37074d544470578602a5a944a45a75 || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha3-512 DXSDK_Aug09.exe.sha3-512]
|- style="text-align:center;vertical-align:center;"
| ''SHAKE128'' || 2a7c81bde9e867cbb5ef00b72ad8de66a3ee64c1d59f16465fa712479b6a84d28a02cc5ed08afa1d51e72011657453dbd4656cc9340d32e18179c39d03982dfc35c8f0c2a5c99e11dc74d0e23ed21b1e55f19c809a5a152bde39a2d46fcd12421f373f2d691ade1b57faf6c2ab7aded5a7d174f1f1c77127c0d6a1523b4775c569c5e1b4efa2da4bf2f708a96707a709e245a7f507382e69a81777919c90e95a091c0b699ce7f517 || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha3-128000 DXSDK_Aug09.exe.sha3-128000]
|- style="text-align:center;vertical-align:center;"
| ''SHAKE256'' || 9c100dac5245a61774f3a2752bf9e941bdcd5654b18035155161c63b20936dfc9bd7334feb9a6fe9a99a65491161083b39ac3bd578e2cf4f90cba3c786e9924fa0611f65a725331b77b63e7c8b552e1637bc77531ba0f2c9cac72115b28e523929ede4e5b246a0755e8d5c4089d94bf16627fb08672cfffa523bba3d976489a0eec60d3c6a96ca2b || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha3-256000 DXSDK_Aug09.exe.sha3-256000]
|- style="text-align:center;vertical-align:center;"
| rowspan="6" | '''{{nowrap|SHA-2}}''' || ''SHA-224'' || a3a74b89cccfe314b79418d5598aac5e94800221e5d945c74f15c004 || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha2-224 DXSDK_Aug09.exe.sha2-224]
|- style="text-align:center;vertical-align:center;"
| ''SHA-256'' || 4ab1de69312f10f6b41310a5218d80c478bbd823bc0f86627318d690b128fb9f || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha2-256 DXSDK_Aug09.exe.sha2-256]
|- style="text-align:center;vertical-align:center;"
| ''SHA-384'' || 254ed29c6ad2cadc6f013d2d51c0ac78a6bbe236a2c94ca99610eba8b2c1200d1a62c445ca9ee51bb09354875d5eca8a || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha2-384 DXSDK_Aug09.exe.sha2-384]
|- style="text-align:center;vertical-align:center;"
| ''SHA-512'' || style="width: 60%;" | 736393c0dfa32221e229890f87eb330174d70dd2a02fa0cace303816d3e7a10a332a44129748de39665d1b339e627d6028c2080268f7afdd5240c447fec8ff0b || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha2-512 DXSDK_Aug09.exe.sha2-512]
|- style="text-align:center;vertical-align:center;"
| ''SHA-512/224'' || 7e23d9ba916000782a17e23abf48e25237f45590cfe767aed9d79f10 || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha2-512224 DXSDK_Aug09.exe.sha2-512224]
|- style="text-align:center;vertical-align:center;"
| ''SHA-512/256'' || 0c833a56046fe7e4213fcb1862c730acf313d1b8f60b51eebf64dc3e79730c1c || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha2-512256 DXSDK_Aug09.exe.sha2-512256]
|- style="text-align:center;vertical-align:center;"
| colspan="2" | '''MD5''' || 66e5379ecf46b014688779621bcc677c || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.md5 DXSDK_Aug09.exe.md5]
|- style="text-align:center;vertical-align:center;"
| colspan="2" | '''{{nowrap|SHA-1}}''' || 5b9b969ed7b6cf5534bb7350e44c09b3573b0e71 || [https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sha1 DXSDK_Aug09.exe.sha1]
|}
CRC32 e9f5c61d ([https://assets.mtasa.com/DXSDK/DXSDK_Aug09.exe.sfv DXSDK_Aug09.exe.sfv]) 

'''NOTE:''' Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

'''Cant find d3dx9.h''' 
Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.
You can find the VC++ Directories list by selecting a project, then pressing the shortcut ALT + ENTER (without the +), then under the 'Configuration properties' you can find 'VC++ Directories', and in there you can find the 'Include Directories' field, click on it and add ''';$(DXSDK_DIR)Include;''' at the end of it.
'''Note: You need to do the same thing in Release mode as well'''

'''Cant find d3dx9.lib''' 
Do do same as in the error above, but instead of ''';$(DXSDK_DIR)Include;''' you must add ''';$(DXSDK_DIR)Lib/x86;''' to the '''Library directories''' field
'''Note: You need to do the same thing in Release mode as well'''

'''S1023 Error''' 
[https://support.microsoft.com/en-us/kb/2728613 "S1023" error when you install the DirectX SDK (June 2010)] 

'''Cannot open source file "xxx.h" after upgrading to Visual Studio 2022''' 
If you've just upgraded to Visual Studio 2022 and were working on MTA using a previous version, you may receive errors about header files not being found (stdio.h, stddef.h, etc) when building the project.

Make sure you have the latest Windows 10 SDK installed (via the Visual Studio Installer) and restart your PC.

If that doesn't work - close Visual Studio, go into the `Build` folder (where your mtasa-blue is located) and delete the `.vs` folder. Start Visual Studio and everything should be fixed.

=== Git Client ===
[[File:Git_logo.png|left|32px|link=https://git-scm.com/]]

If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].

If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

== Getting the latest source code ==

To get the latest code, you will have to download the latest copy of our Git repository. 
We recommend cloning the repository in your Git client because you can pull any updates from there easily.

* '''Repository:''' [https://github.com/multitheftauto/mtasa-blue multitheftauto/mtasa-blue]
* '''.zip:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.zip master.zip]
* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

== Compiling the code ==
# Execute the script '''win-create-projects.bat'''
# Open the solution file '''MTASA.sln''' in the '''Build''' directory
# If you are asked to upgrade the project, click '''Cancel'''
# Select '''Debug''' - '''Win32''' configuration in Visual Studio, then press Build > Build Solution... (may take some minutes)
# Execute the script '''win-install-data.bat'''

= Running the software =

== Running the client ==

You can start your client in the '''Bin''' directory. You might find there a ''Multi Theft Auto.exe'' and/or ''Multi Theft Auto_d.exe'' executable. The ''_d'' suffix indicates a debug build of the software. 
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

== Running the dedicated server ==

If you already have run step 5 (''Install resources'') in ''Compiling the code'' to install resources then you can go to ''Starting the server''.

=== Installing the latest resources ===
If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is [https://github.com/multitheftauto/mtasa-resources hosted on GitHub]. You can download the latest resources from there or [http://mirror.mtasa.com/mtasa/resources/ download a zipped version]. Make sure that you have the latest resources package.

=== Starting the server ===
To run the server, open the ''MTA Server.exe'' executable in the '''Bin/server''' directory. The ''_d'' suffix indicates a debug build of the software. 
You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

== Debugging ==
If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build. 
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio. 
[[File:Local_Windows_Debugger.PNG]]

=== How to enable breakpoints ===
If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise, your
breakpoints will not work for anything besides the MTA Launcher project. 
[[File:Attach_to_Process.png|600px]]

=== Extending timeout duration ===
When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
The content of the file is the new timeout duration in seconds, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

=== ReAttach for Visual Studio ===
You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio. 
[[File:ReAttach_to_GTASA.PNG]]

= Getting involved =
Please see our [[Coding guidelines]] for information on the coding practice.

= Additional information =
If you need more information, try our [http://bugs.mtasa.com/ bug tracker] or [irc://irc.multitheftauto.com IRC channel].

= Errors =
== CL38 error. [netc_d.dll not found] ==
Solution: Delete '''Multi Theft Auto_d.exe''' and hit compile again.

== After cloning the repository, it doesn't compile the project ==
Solution: Execute '''win-create-projects.bat''' in main directory.

== CL17 Load field. Please ensure that the latest data files have been installed correctly ==
Solution: Execute '''win-install-data.bat''' in main directory.

== ERROR: Loading network library (net_d.dll) failed! ==
Solution: Execute '''win-install-data.bat''' in main directory.

[[en:Compiling MTASA]]
[[hu:Compiling MTASA]]
[[pt-br:Compilando o MTASA]]
[[ru:Compiling MTASA]]
[[Category: Development]]

SetBrowserRenderingPaused

2020-10-19T20:45:42Z

Haron4igg: Added warning about flaky browser behaviour on PC with low ram, when using setBrowserRenderingPaused

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function sets the rendering state of a browser.
}}
{{MessageBox|bordercolorhex=FFB2B2|bgcolorhex=FFE5E5|image=File:Dialog-warning.png|title=Warning:|message=May cause issues with browser rendering on PC with low Ram [https://github.com/multitheftauto/mtasa-blue/issues/1567 #1567]. It's might be better to completely release browser, instead of pausing it, when its not needed.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setBrowserRenderingPaused ( browser webBrowser, bool paused )
</syntaxhighlight>
{{OOP|As of MTA: SA {{Current Version|master}} the counterpart is not implemented yet.|[[browser]]:setRenderingPaused|renderingPaused|isBrowserRenderingPaused}}

===Required Arguments===
*'''webBrowser:''' The browser
*'''paused:''' ''true'' to pause rendering, ''false'' to continue

===Returns===
Returns ''true'' if the state was successfully changed

==Example==
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in remote mode.
local window = guiCreateWindow(0, 0, screenWidth, screenHeight, "Webbrowser", false)
local browser = guiCreateBrowser(0, 0, 800, 600, false, false, false, window)

-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL
local theBrowser = guiGetBrowser(browser) -- Get the browser element from gui-browser
addEventHandler("onClientBrowserCreated", theBrowser,
function()
-- After the browser has been initialized, we can load www.youtube.com
loadBrowserURL(source, "http://www.youtube.com")
end
)

addCommandHandler ("pause", -- Add command named 'pause'
function (player, command, value)
if (value) then -- checking for a value
setBrowserRenderingPaused (theBrowser, value)
else -- if there is no value
outputChatBox ("You must enter a value.", player)
end
end
)
</syntaxhighlight>

==See also==
{{CEF_functions}}

[[hu:setBrowserRenderingPaused]]
[[RO:setBrowserRenderingPaused]]