SetTransferBoxVisible: Difference between revisions
Jump to navigation
Jump to search
(add setTransferBoxVisible) |
No edit summary |
||
(6 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
{{ | {{Added feature/item|1.5.9|1.5.8|20788|Determines whether or not the transfer box should appear to [[Player|players]].}} | ||
==Syntax== | ==Syntax== | ||
Line 9: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''visible:''' The new visibility state. | *'''visible:''' The new transfer box visibility state. | ||
===Returns=== | ===Returns=== | ||
Line 15: | Line 15: | ||
==Examples== | ==Examples== | ||
<section name="Server" class="server" show="true"> | <section name="Server" class="server" show="true"> | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addEventHandler( | addEventHandler ("onResourceStart", resourceRoot, function() | ||
setTransferBoxVisible(false) | setTransferBoxVisible (false) | ||
end) | end) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 27: | Line 25: | ||
==Requirements== | ==Requirements== | ||
{{Requirements|1.5.8-9.20788|1.5.8-9.20788|}} | {{Requirements|1.5.8-9.20788|1.5.8-9.20788|}} | ||
==See Also== | |||
{{Server_functions}} |
Latest revision as of 21:31, 23 September 2021
Determines whether or not the transfer box should appear to players.
Syntax
bool setTransferBoxVisible ( bool visible )
Required Arguments
- visible: The new transfer box visibility state.
Returns
Returns true if the visibility was set successfully, false otherwise.
Examples
Click to collapse [-]
ServeraddEventHandler ("onResourceStart", resourceRoot, function() setTransferBoxVisible (false) end)
Requirements
Minimum server version | 1.5.8-9.20788 |
---|---|
Minimum client version | 1.5.8-9.20788 |
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 server="1.5.8-9.20788" client="1.5.8-9.20788" />
See Also
- getFPSLimit
- getMaxPlayers
- getServerHttpPort
- getServerName
- getServerPassword
- getServerPort
- getVersion
- isGlitchEnabled
- isTransferBoxAlwaysVisible
- isTransferBoxVisible
- setFPSLimit
- setGlitchEnabled
- setMaxPlayers
- setServerPassword
- setTransferBoxVisible
- shutdown