IsTransferBoxVisible

Determines if the transfer box should be visible.

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.

Examples

Click to collapse [-]

Client

This 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)
    else 
        outputChatBox("* "..getPlayerName(localPlayer).." you are not downloading the server!", 255, 255, 255, true)        
    end
end
addCommandHandler("download2", isVisible)

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
• isTransferBoxVisible
• setTransferBoxVisible