EngineGetModelVisibleTime: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.5.8|20416|This function returns model visibility time, this is used for example for building lights being shown afte...")
 
No edit summary
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0160|1.5.8|20416|This function returns model visibility time, this is used for example for building lights being shown after 23:00.}}
{{Added feature/item|1.5.9|1.5.8|20704|This function returns a model's visibility time, this is used for example for building lights being shown after 23:00.}}


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">int, int engineGetModelVisibleTime( modelID )</syntaxhighlight>  
<syntaxhighlight lang="lua">int, int engineGetModelVisibleTime ( int modelId )</syntaxhighlight>  
===Required Arguments===
===Required Arguments===
*'''modelID''': ID of the model
*'''modelId''': The ID of the model.


===Returns===
===Returns===
Returns '''timeOn''', '''timeOff'''
Returns 2 [[integer]]s, indicating ''timeOn'' and ''timeOff''.


==Example==  
==Example==  
<section name="Client" class="client" show="true">
Make Los Santos Tower visible only between 10 and 12 AM.
Make Los Santos Tower visible only between 10 and 12 AM.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function init()
function init ()
engineSetModelVisibleTime(4550, 10, 12)
engineSetModelVisibleTime (4550, 10, 12)
         local timeOn, timeOff = engineGetModelVisibleTime(4550)
         local timeOn, timeOff = engineGetModelVisibleTime (4550)
         outputChatBox('Los Santos Tower visible time is now between ' .. timeOn .. ' and ' .. timeOff)
         outputChatBox ("Los Santos Tower visible time is now between " .. timeOn .. " and " .. timeOff)
end
end
addEventHandler("onClientResourceStart", resourceRoot, init)
 
addEventHandler ("onClientResourceStart", resourceRoot, init)
</syntaxhighlight>
</syntaxhighlight>
</section>


==Requirements==
==Requirements==
{{Requirements|n/a|1.5.8-9.20416|}}
{{Requirements|n/a|1.5.8-9.20704|}}
 
==See Also==
==See Also==
{{Engine_functions}}
{{Engine_functions}}

Latest revision as of 20:37, 23 September 2021

This function returns a model's visibility time, this is used for example for building lights being shown after 23:00.

Syntax

int, int engineGetModelVisibleTime ( int modelId )

Required Arguments

  • modelId: The ID of the model.

Returns

Returns 2 integers, indicating timeOn and timeOff.

Example

Make Los Santos Tower visible only between 10 and 12 AM.

function init ()
	engineSetModelVisibleTime (4550, 10, 12)
        local timeOn, timeOff = engineGetModelVisibleTime (4550)
        outputChatBox ("Los Santos Tower visible time is now between " .. timeOn .. " and " .. timeOff)
end

addEventHandler ("onClientResourceStart", resourceRoot, init)

Requirements

Minimum server version n/a
Minimum client version 1.5.8-9.20704

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.5.8-9.20704" />

See Also