SetWeaponRenderEnabled and ResetWorldProperties: Difference between pages

From Multi Theft Auto: Wiki
(Difference between pages)
Jump to navigation Jump to search
No edit summary
 
m (Move unnecessary note section to desc)
 
Line 1: Line 1:
__NOTOC__
__NOTOC__  
{{Client function}}
{{Shared function}}
{{New feature/item|3.0161|1.6.0|22880|This function allows you to disable GTA weapon rendering for [[ped]], [[player]]. It is particularly useful for creating own weapon system, where sole weapon ID could have many different custom models.}}
{{New feature/item|3.0161|1.6.0|22741|This function resets all world properties to default.
{{Tip|You can use it for example with optimized bone_attach resource called [https://github.com/Patrick2562/mtasa-pAttach pAttach].}}
 
Regardless of the value of the arguments, the following properties are reset:
* Far clip distance
* Near clip distance
* Clouds (enabled)
* Birds (enabled)
* Occlusions (enabled)
* Gravity
* Game speed
* Aircraft max height & velocity
* Jetpack max height
* Interior furnitures (enabled)
* Minute duration
* Blur level
* Corona reflections
* Traffic lights locked state
* Water level and color
* Wave height
* Volumetric shadows
* Game time freeze
* Dynamic ped shadows
}}


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">nil resetWorldProperties( [ bool resetSpecialProperties = true, bool resetWorldProperties = true, bool resetWeatherProperties = true, bool resetLODs = true, bool resetSounds = true, bool resetGlitches = true, bool resetJetpackWeapons = true ] )</syntaxhighlight>
bool setWeaponRenderEnabled ( bool enabled )
===Optional arguments===
</syntaxhighlight>  
{{OptionalArg}}
 
* '''resetSpecialProperties:''' Restores all special world properties changed by [[setWorldSpecialPropertyEnabled]] to default.
===Required Arguments===
* '''resetWorldProperties:''' Reset all world properties changed by [[setWorldProperty]].
*'''enabled:''' Whether weapon render should be enabled.
* '''resetWeatherProperties:''' Reset all weather properties like heat haze, rain level, sun color etc.
* '''resetLODs:''' Reset vehicles and peds lod distance.
* '''resetSounds:''' Restore interior sounds, world sounds and ambient sounds.
<section name="Server" class="server" show="true">
* '''resetGlitches:''' Disable all glitches enabled by [[setGlitchEnabled]].
* '''resetJetpackWeapons:''' Reset jetpack weapons changes by [[setJetpackWeaponEnabled]] to default (uzi, pistol, tec9).
</section>


===Returns===
===Returns===
Always returns '''true'''.
This function returns nothing (''nil'').


==Example==
==Example==
This example disables weapon rendering once resource has started.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onClientResourceStartDisableWeaponRender()
resetWorldProperties()
setWeaponRenderEnabled(false)
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStartDisableWeaponRender)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Weapon functions|client}}
{{World functions}}

Latest revision as of 17:12, 11 November 2025

ADDED/UPDATED IN VERSION 1.6.0 r22741:
This function resets all world properties to default.

Regardless of the value of the arguments, the following properties are reset:

  • Far clip distance
  • Near clip distance
  • Clouds (enabled)
  • Birds (enabled)
  • Occlusions (enabled)
  • Gravity
  • Game speed
  • Aircraft max height & velocity
  • Jetpack max height
  • Interior furnitures (enabled)
  • Minute duration
  • Blur level
  • Corona reflections
  • Traffic lights locked state
  • Water level and color
  • Wave height
  • Volumetric shadows
  • Game time freeze
  • Dynamic ped shadows

Syntax

nil resetWorldProperties( [ bool resetSpecialProperties = true, bool resetWorldProperties = true, bool resetWeatherProperties = true, bool resetLODs = true, bool resetSounds = true, bool resetGlitches = true, bool resetJetpackWeapons = true ] )

Optional arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • resetSpecialProperties: Restores all special world properties changed by setWorldSpecialPropertyEnabled to default.
  • resetWorldProperties: Reset all world properties changed by setWorldProperty.
  • resetWeatherProperties: Reset all weather properties like heat haze, rain level, sun color etc.
  • resetLODs: Reset vehicles and peds lod distance.
  • resetSounds: Restore interior sounds, world sounds and ambient sounds.
Click to collapse [-]
Server

Returns

This function returns nothing (nil).

Example

resetWorldProperties()

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetWeaponRenderEnabled?oldid=82608"