SetWorldSpecialPropertyEnabled: Difference between revisions

Revision as of 07:16, 2 August 2023

Enables or disables a special world property.

Syntax

bool setWorldSpecialPropertyEnabled ( string propname, bool enable )

OOP Syntax Help! I don't understand this!

Counterpart: isWorldSpecialPropertyEnabled

A photo demonstrating randomfoliage 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)
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,
	}
	
	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

@@ Line 20: / Line 20: @@
 **{{New feature/item|3.0160|1.5.9|21125|'''vehiclesunglare''' - toggle the vehicle sun glare effect (default: false) }}
 **{{New feature/item|3.0160|1.5.9|21313| '''coronaztest''' - disable big sun lensflare effect (default: true) }}
+**{{New feature/item|3.0161|1.6.0|21919| '''watercreatures''' - toggle randomly generated underwater creatures (default: true) }}
 *'''enable:''' whether or not to enable the property.
@@ Line 41: / Line 42: @@
 		["vehiclesunglare"] = false,
 		["coronaztest"] = true,
+		["watercreatures"] = true,
 	}
@@ Line 55: / Line 57: @@
 {{ChangelogItem|1.5.9-1.21125|Added "vehiclesunglare" property}}
 {{ChangelogItem|1.5.9-9.21313|Added "coronaztest" property}}
+{{ChangelogItem|1.6.0-9.21919|Added "watercreatures" property}}
 ==See Also==
 {{Client world functions}}