Difference between revisions of "GetOcclusionsEnabled"

From Multi Theft Auto: Wiki
(new page)
 
 
Line 2: Line 2:
 
{{Server client function}}
 
{{Server client function}}
 
This function is used to get "occlusions enabled" state.
 
This function is used to get "occlusions enabled" state.
 
+
{{Note|Occlusions are used by GTA to enhance performance by hiding objects that are (normally) obscured by certain large buildings. However when [[removeWorldModel]] is used they may also have the undesired effect of making parts of the map disappear. Disabling occlusions will fix that.}}
'''Note:''' Occlusions are used by GTA to enhance performance by hiding objects that are (normally) obscured by certain large buildings. However when [[removeWorldModel]] is used they may also have the undesired effect of making parts of the map disappear. Disabling occlusions will fix that.
 
  
 
==Syntax==
 
==Syntax==

Latest revision as of 06:04, 11 August 2019

This function is used to get "occlusions enabled" state.

[[{{{image}}}|link=]] Note: Occlusions are used by GTA to enhance performance by hiding objects that are (normally) obscured by certain large buildings. However when removeWorldModel is used they may also have the undesired effect of making parts of the map disappear. Disabling occlusions will fix that.

Syntax

bool getOcclusionsEnabled ( )

Returns

Returns true if occlusions are enabled, or false otherwise.

Example

This example shows how to disable occlusions after the whole map has been cleared:

-- Remove all world models
for i=700,20000 do
    removeWorldModel(i,10000,0,0,0)
end

-- Turn off occlusions with simple check
if getOcclusionsEnabled() then
    setOcclusionsEnabled( false )
end

Requirements

Minimum supported server 1.3
Minimum supported client 1.3

Note: Using this function requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.3" client="1.3" />

See Also