IsTransferBoxVisible: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server client function}} | {{Server client function}} | ||
{{ | {{Added feature/item|3.0159|1.5.9|1.5.8|20788|Determines if the transfer box is visible.}} | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool isTransferBoxVisible() | bool isTransferBoxVisible ( ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 13: | Line 13: | ||
On '''client''' this returns a boolean, whether the transfer box should be visible or not at the time of invocation. | On '''client''' this returns a boolean, whether the transfer box should be visible or not at the time of invocation. | ||
== | ==Example== | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
This example defines a command to remove the player's transfer box. | This example defines a command to remove the player's transfer box. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function isVisible() | function isVisible () | ||
if isTransferBoxVisible() then | if isTransferBoxVisible () then | ||
setTransferBoxVisible(false) | setTransferBoxVisible (false) | ||
outputChatBox("* "..getPlayerName(localPlayer).." you are downloading the server!", 255, 255, 255, true) | outputChatBox ("* "..getPlayerName (localPlayer).." you are downloading the server!", 255, 255, 255, true) | ||
end | end | ||
end | end | ||
addCommandHandler("download2", isVisible) | addCommandHandler ("download2", isVisible) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
</section> | </section> | ||
Revision as of 11:43, 20 September 2021
20788
Syntax
bool isTransferBoxVisible ( )
Returns
On server this returns a boolean, whether the transfer box should be visible during downloads or not.
On client this returns a boolean, whether the transfer box should be visible or not at the time of invocation.
Example
Click to collapse [-]
ClientThis example defines a command to remove the player's transfer box.
function isVisible ()
if isTransferBoxVisible () then
setTransferBoxVisible (false)
outputChatBox ("* "..getPlayerName (localPlayer).." you are downloading the server!", 255, 255, 255, true)
end
end
addCommandHandler ("download2", isVisible)
Requirements
This template will be deleted.