Difference between revisions of "SetWorldSpecialPropertyEnabled"

From Multi Theft Auto: Wiki
m (Example)
(Required Arguments)
 
(13 intermediate revisions by 9 users not shown)
Line 2: Line 2:
 
{{Client function}}
 
{{Client function}}
  
Enables or disables a special world property (cheat).
+
Enables or disables a special world property.
  
 
==Syntax==
 
==Syntax==
 
<syntaxhighlight lang="lua">bool setWorldSpecialPropertyEnabled ( string propname, bool enable )</syntaxhighlight>
 
<syntaxhighlight lang="lua">bool setWorldSpecialPropertyEnabled ( string propname, bool enable )</syntaxhighlight>
 +
{{OOP||||isWorldSpecialPropertyEnabled}}
  
 
===Required Arguments===
 
===Required Arguments===
 
*'''propname:''' the name of the property to set. Possible values are:
 
*'''propname:''' the name of the property to set. Possible values are:
**'''hovercars''' - no known equivalent PC cheat, and allows cars to drive on water.
+
**'''hovercars''' - equivalent of the JBGVNB cheat, and allows cars to drive on water.
 
**'''aircars''' - equivalent of the RIPAZHA cheat, and allows cars to fly.
 
**'''aircars''' - equivalent of the RIPAZHA cheat, and allows cars to fly.
 
**'''extrabunny''' - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher.
 
**'''extrabunny''' - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher.
 
**'''extrajump''' - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher.
 
**'''extrajump''' - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher.
 +
**'''randomfoliage''' - toggle randomly generated foliage on the GTA:SA map (default: true) [https://wiki.multitheftauto.com/wiki/File:Randomfoliage.jpeg Image]
 +
**'''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)
 +
**{{New feature/item|3.0156|1.5.5|12286|'''underworldwarp''' - toggle warp of peds and vehicles when fall under map (default: true)}}
 
*'''enable:''' whether or not to enable the property.
 
*'''enable:''' whether or not to enable the property.
  
Line 20: Line 25:
 
==Example==
 
==Example==
  
Function which allow cars to fly.
+
'''Example 1:''' Allows cars to fly.
 
 
<section name="Client" class="client" show="true">
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
addEventHandler( "onClientResourceStart", resourceRoot,
 
addEventHandler( "onClientResourceStart", resourceRoot,
function()
+
    function( )
setWorldSpecialPropertyEnabled("aircars", true)
+
        setWorldSpecialPropertyEnabled( "aircars", true )
end
+
    end
 
)
 
)
 
</syntaxhighlight>
 
</syntaxhighlight>
</section>
 
  
'''Example 2:'''
+
'''Example 2:''' Allow cars to drive on water.
Allow cars to drive on water.
 
<section name="Client" class="client" show="true">
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
addEventHandler( "onClientResourceStart", resourceRoot,
 
addEventHandler( "onClientResourceStart", resourceRoot,
function()
+
    function( )
setWorldSpecialPropertyEnabled("hovercars", true)
+
        setWorldSpecialPropertyEnabled( "hovercars", true )
end
+
    end
 
)</syntaxhighlight>
 
)</syntaxhighlight>
</section>
+
 
 +
==Changelog==
 +
{{ChangelogHeader}}
 +
{{ChangelogItem|1.5.5-3.12286|Added "underworldwarp" property}}
  
 
==See Also==
 
==See Also==
 
{{Client world functions}}
 
{{Client world functions}}

Latest revision as of 14:11, 9 August 2019

Enables or disables a special world property.

Syntax

bool setWorldSpecialPropertyEnabled ( string propname, bool enable )

OOP Syntax Help! I don't understand this!

Counterpart: isWorldSpecialPropertyEnabled

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.
    • aircars - equivalent of the RIPAZHA cheat, and allows cars to fly.
    • extrabunny - equivalent of the CJPHONEHOME or JHJOECW cheat, and allows you to bunny hop on bicycles much higher.
    • extrajump - equivalent of the KANGAROO cheat, and allows you to jump on foot much higher.
    • randomfoliage - toggle randomly generated foliage on the GTA:SA map (default: true) Image
    • 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)
  • enable: whether or not to enable the property.

Returns

Returns true if successful, false otherwise.

Example

Example 1: Allows cars to fly.

addEventHandler( "onClientResourceStart", resourceRoot,
    function( )
        setWorldSpecialPropertyEnabled( "aircars", true )
    end
)

Example 2: Allow cars to drive on water.

addEventHandler( "onClientResourceStart", resourceRoot,
    function( )
        setWorldSpecialPropertyEnabled( "hovercars", true )
    end
)

Changelog

Version Description
1.5.5-3.12286 Added "underworldwarp" property

See Also