IsTransferBoxActive: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(OOP syntax)
Line 8: Line 8:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isTransferBoxActive ()
bool isTransferBoxActive ()
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]].isTransferBoxActive||}}


===Returns===
===Returns===

Revision as of 20:32, 7 November 2018

This function returns whether the file downloading dialog box is active or not. This appears when a resource is started and the client doesn't have all the files that resource requires the client to have.

It's important to note that resources aren't started on the client until they're completely downloaded, so a resource cannot use this function to detect if it's own files are downloaded. A client-side resource triggers the onClientResourceStart event when the files it requires are downloaded.

Syntax

bool isTransferBoxActive ()

OOP Syntax Help! I don't understand this!

Method: GuiElement.isTransferBoxActive(...)


Returns

Returns true if the file transfer box is visible, false if not.

Example

This makes the camera fade in, once all resource downloads are finished. 

resourceRoot = getResourceRootElement(getThisResource())
function checkTransfer()
	if isTransferBoxActive() then
		setTimer(checkTransfer,2000,1) -- Check again after 2 seconds
	else 
		fadeCamera(true)  -- TransferBox isnt active, fade in camera
	end
end
addEventHandler("onClientResourceStart",resourceRoot,checkTransfer)

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Retrieved from "https://wiki.multitheftauto.com/wiki/IsTransferBoxActive?oldid=60479"