SetWorldSpecialPropertyEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Example fix)
mNo edit summary
 
(10 intermediate revisions by 5 users not shown)
Line 7: Line 7:


{{Note|
{{Note|
It's recommended to use server-side function with appropriate [[mtaserver.conf#minclientversion|minclientversion]] for properties like "'''underworldwarp'''", "'''burnflippedcars'''", "'''extendedwatercannons'''" to avoid possible data desynchronization.
It's recommended to use server-side function with appropriate [[mtaserver.conf#minclientversion|minclientversion]] for properties like "'''underworldwarp'''", "'''burnflippedcars'''", "'''extendedwatercannons'''", "'''flyingcomponents'''", "'''vehicle_engine_autostart'''" to avoid possible data desynchronization.
}}
}}


Line 33: Line 33:
**{{New feature/item|3.0161|1.6.0|22430| '''roadsignstext''' - toggle the drawing of text on road signs. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22430| '''roadsignstext''' - toggle the drawing of text on road signs. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22485| '''extendedwatercannons''' - Increases the default limit of water cannons used at the same time from 3 to 30. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22485| '''extendedwatercannons''' - Increases the default limit of water cannons used at the same time from 3 to 30. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22596| '''tunnelweatherblend''' - toggle the weather blending effect when the player is in the tunnel. (default: true)}}
**{{New feature/item|3.0161|1.6.0|22815| '''ignorefirestate''' - Allows aiming when the player is on fire and entering burning vehicles. (default: false)}}
**{{New feature/item|3.0161|1.6.0|22909| '''flyingcomponents''' - This property determines whether the detached components such as doors, bumpers, etc., should respawn after a vehicle is recreated (change model or variant) or streamed in. (default: true)}}
**{{New feature/item|3.0161|1.6.0|23223| '''vehicleburnexplosions''' - This property toggles creation of additional explosions ([[Explosion_types|type 2 - rocket]]) when plane or helicopter is burning. (default: true)}}
**{{New feature/item|3.0161|1.6.0|23237| '''vehicle_engine_autostart''' - This property toggles automatic vehicle engine state behavior. (default: true)<br>If you set it to ''false'' then vehicle engine will not start on driver enter and will not stop on driver exit. To control the engine you need to use [[SetVehicleEngineState|setVehicleEngineState]]. Helicopter rotors will spin only if the engine is on (with or without driver inside).<br>This flag also affects bikes}}
*'''enable:''' whether or not to enable the property.
*'''enable:''' whether or not to enable the property.


Line 42: Line 47:
This code allows you to enable/disable certain property using '''true''' or '''false'''.
This code allows you to enable/disable certain property using '''true''' or '''false'''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onClientResourceStart()
local worldSpecialProperties = {
local worldSpecialProperties = {
["hovercars"] = false,
["hovercars"] = false,
["aircars"] = false,
["aircars"] = false,
["extrabunny"] = false,
["extrabunny"] = false,
["extrajump"] = false,
["extrajump"] = false,
["randomfoliage"] = true,
["randomfoliage"] = true,
["snipermoon"] = false,
["snipermoon"] = false,
["extraairresistance"] = true,
["extraairresistance"] = true,
["underworldwarp"] = true,
["underworldwarp"] = true,
["vehiclesunglare"] = false,
["vehiclesunglare"] = false,
["coronaztest"] = true,
["coronaztest"] = true,
["watercreatures"] = true,
["watercreatures"] = true,
["burnflippedcars"] = true,
["burnflippedcars"] = true,
["fireballdestruct"] = true,
["fireballdestruct"] = true,
["roadsignstext"] = true,
["roadsignstext"] = true,
["extendedwatercannons"] = true,
["extendedwatercannons"] = true,
["tunnelweatherblend"] = true,
}
["ignorefirestate"] = false,
["flyingcomponents"] = true,
["vehicleburnexplosions"] = true,
["vehicle_engine_autostart"] = true,
}
 
local function toggleWorldSpecialProperties()
for propertyName, propertyState in pairs(worldSpecialProperties) do
for propertyName, propertyState in pairs(worldSpecialProperties) do
setWorldSpecialPropertyEnabled(propertyName, propertyState)
setWorldSpecialPropertyEnabled(propertyName, propertyState)
end
end
end
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)
addEventHandler("onClientResourceStart", resourceRoot, toggleWorldSpecialProperties)
</syntaxhighlight>
</syntaxhighlight>


Line 78: Line 88:
{{ChangelogItem|1.6.0-9.22430|Added "roadsignstext" property}}
{{ChangelogItem|1.6.0-9.22430|Added "roadsignstext" property}}
{{ChangelogItem|1.6.0-9.22485|Added "extenedwatercannons" property}}
{{ChangelogItem|1.6.0-9.22485|Added "extenedwatercannons" property}}
{{ChangelogItem|1.6.0-9.22596|Added "tunnelweatherblend" property}}
{{ChangelogItem|1.6.0-9.22815|Added "ignorefirestate" property}}
{{ChangelogItem|1.6.0-9.22909|Added "flyingcomponents" property}}
{{ChangelogItem|1.6.0-9.23223|Added "vehicleburnexplosions" property}}
{{ChangelogItem|1.6.0-9.23237|Added "vehicle_engine_autostart" property}}


==See Also==
==See Also==
{{Shared world functions}}
{{World functions}}

Latest revision as of 04:53, 31 October 2025

ADDED/UPDATED IN VERSION 1.6.0 r22195:
Added also as a server-side function. Previously only available as a client-side function.

Enables or disables a special world property.

[[{{{image}}}|link=|]] Note:

It's recommended to use server-side function with appropriate minclientversion for properties like "underworldwarp", "burnflippedcars", "extendedwatercannons", "flyingcomponents", "vehicle_engine_autostart" to avoid possible data desynchronization.

Syntax

bool setWorldSpecialPropertyEnabled ( string propname, bool enable )

OOP Syntax Help! I don't understand this!

Counterpart: isWorldSpecialPropertyEnabled


A photo demonstrating randomfoliage enabled and disabled.
A photo demonstrating roadsignstext enabled and disabled.
A photo demonstrating extendedwatercannons enabled and disabled.

Required Arguments

  • propname: the name of the property to set. Possible values are:
    • hovercars - equivalent of the JBGVNB cheat, and allows cars to drive on water. (default: false)
    • aircars - equivalent of the RIPAZHA cheat, and allows cars to fly. (default: false)
    • extrabunny - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher. (default: false)
    • extrajump - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher. (default: false)
    • randomfoliage - toggle randomly generated foliage on the GTA:SA map (default: true)
    • snipermoon - toggle the GTA:SA easter egg, which increases the size of the moon every time you shoot it with a sniper rifle (default: false)
    • extraairresistance - toggle the vehicle speed limit on cross-country roads (default: true)
    • underworldwarp - toggle warp of peds and vehicles when fall under map (default: true)
    • vehiclesunglare - toggle the vehicle sun glare effect (default: false)
    • coronaztest - disable big sun lensflare effect (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r21919:
      watercreatures - toggle randomly generated underwater creatures (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22195:
      burnflippedcars - toggle the vehicle to burn when upside down (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22199:
      fireballdestruct - toggle the aircraft model destruction on explosion (preview) (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22430:
      roadsignstext - toggle the drawing of text on road signs. (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22485:
      extendedwatercannons - Increases the default limit of water cannons used at the same time from 3 to 30. (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22596:
      tunnelweatherblend - toggle the weather blending effect when the player is in the tunnel. (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r22815:
      ignorefirestate - Allows aiming when the player is on fire and entering burning vehicles. (default: false)
    • ADDED/UPDATED IN VERSION 1.6.0 r22909:
      flyingcomponents - This property determines whether the detached components such as doors, bumpers, etc., should respawn after a vehicle is recreated (change model or variant) or streamed in. (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r23223:
      vehicleburnexplosions - This property toggles creation of additional explosions (type 2 - rocket) when plane or helicopter is burning. (default: true)
    • ADDED/UPDATED IN VERSION 1.6.0 r23237:
      vehicle_engine_autostart - This property toggles automatic vehicle engine state behavior. (default: true)
      If you set it to false then vehicle engine will not start on driver enter and will not stop on driver exit. To control the engine you need to use setVehicleEngineState. Helicopter rotors will spin only if the engine is on (with or without driver inside).
      This flag also affects bikes
  • enable: whether or not to enable the property.

Returns

Returns true if successful, false otherwise.

Example

This code allows you to enable/disable certain property using true or false. 

local worldSpecialProperties = {
	["hovercars"] = false,
	["aircars"] = false,
	["extrabunny"] = false,
	["extrajump"] = false,
	["randomfoliage"] = true,
	["snipermoon"] = false,
	["extraairresistance"] = true,
	["underworldwarp"] = true,
	["vehiclesunglare"] = false,
	["coronaztest"] = true,
	["watercreatures"] = true,
	["burnflippedcars"] = true,
	["fireballdestruct"] = true,
	["roadsignstext"] = true,
	["extendedwatercannons"] = true,
	["tunnelweatherblend"] = true,
	["ignorefirestate"] = false,
	["flyingcomponents"] = true,
	["vehicleburnexplosions"] = true,
	["vehicle_engine_autostart"] = true,
}

local function toggleWorldSpecialProperties()
	for propertyName, propertyState in pairs(worldSpecialProperties) do
		setWorldSpecialPropertyEnabled(propertyName, propertyState)
	end
end
addEventHandler("onClientResourceStart", resourceRoot, toggleWorldSpecialProperties)

Changelog

Version Description
1.5.5-3.12286 Added "underworldwarp" property
1.5.9-1.21125 Added "vehiclesunglare" property
1.5.9-9.21313 Added "coronaztest" property
1.6.0-9.21919 Added "watercreatures" property
1.6.0-9.22195 Added "burnflippedcars" property
1.6.0-9.22199 Added "fireballdestruct" property
1.6.0-9.22430 Added "roadsignstext" property
1.6.0-9.22485 Added "extenedwatercannons" property
1.6.0-9.22596 Added "tunnelweatherblend" property
1.6.0-9.22815 Added "ignorefirestate" property
1.6.0-9.22909 Added "flyingcomponents" property
1.6.0-9.23223 Added "vehicleburnexplosions" property
1.6.0-9.23237 Added "vehicle_engine_autostart" property

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetWorldSpecialPropertyEnabled?oldid=82581"