SetWorldSpecialPropertyEnabled: Difference between revisions

Latest revision as of 14:27, 4 June 2024

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" 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)
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.

function onClientResourceStart()
	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,
	}
	
	for propertyName, propertyState in pairs(worldSpecialProperties) do
		setWorldSpecialPropertyEnabled(propertyName, propertyState)
	end
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStart)

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

@@ Line 7: / Line 7: @@
 {{Note|
-It's recommended to use server-side function with appropriate [[mtaserver.conf#minclientversion|minclientversion]] for properties like "'''underworldwarp'''", "'''burnflippedcars'''" 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'''" to avoid possible data desynchronization.
 }}
@@ Line 14: / Line 14: @@
 {{OOP||||isWorldSpecialPropertyEnabled}}
 [[File:Randomfoliage.jpeg|frame|right|A photo demonstrating ''randomfoliage'' enabled and disabled.]]
+[[File:Roadsignstext.png|frame|right|A photo demonstrating ''roadsignstext'' enabled and disabled.]]
+[[File:Extendedwatercannons.png|frame|right|A photo demonstrating ''extendedwatercannons'' enabled and disabled.]]
 ===Required Arguments===
 *'''propname:''' the name of the property to set. Possible values are:
@@ Line 30: / Line 32: @@
 **{{New feature/item|3.0161|1.6.0|22199| '''fireballdestruct''' - toggle the aircraft model destruction on explosion ([[Media:FireballDestruct.jpg|preview]]) (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)}}
 *'''enable:''' whether or not to enable the property.
@@ Line 55: / Line 58: @@
 		["fireballdestruct"] = true,
 		["roadsignstext"] = true,
+		["extendedwatercannons"] = true,
 	}
@@ Line 73: / Line 77: @@
 {{ChangelogItem|1.6.0-9.22199|Added "fireballdestruct" property}}
 {{ChangelogItem|1.6.0-9.22430|Added "roadsignstext" property}}
+{{ChangelogItem|1.6.0-9.22485|Added "extenedwatercannons" property}}
 ==See Also==
 {{Shared world functions}}