UIManager.SetUICursor (Civ5 API)

From Civilization Modding Wiki
Jump to: navigation, search

This page is a part of the Lua and UI Reference (Civ5).


Function.png This function is a member of UIManager.

This is a static method, invoke it with a dot.


Usage

PolicyBranchType UIManager.SetUICursor(PolicyBranchType oldCursor)


Returned Value

No description available.

Parameters

oldCursor: No description available.


Source code samples

Redundant occurences have been removed.

AdvancedSetup.lua

UI/FrontEnd/GameSetup/AdvancedSetup.lua
1181
UIManager:SetUICursor( 1 );


CivilopediaScreen.lua

UI/Civilopedia/CivilopediaScreen.lua
6265
UIManager:SetUICursor( 0 );


InGame.lua

UI/InGame/InGame.lua
0702
UIManager:SetUICursor(cursorIndex);
0704
UIManager:SetUICursor(defaultCursor);
0720
UIManager:SetUICursor(1); -- busy


JoiningRoom.lua

UI/FrontEnd/Multiplayer/JoiningRoom.lua
0120
local prevCursor = UIManager:SetUICursor( 1 );
0122
UIManager:SetUICursor( prevCursor );


LoadReplayMenu.lua

UI/FrontEnd/LoadReplayMenu.lua
0023
UIManager:SetUICursor(1);
0028
UIManager:SetUICursor(0);


Lobby.lua

UI/FrontEnd/Multiplayer/Lobby.lua
0149
UIManager:SetUICursor( 1 ); -- Busy
0167
UIManager:SetUICursor( 0 ); -- Normal


TradeLogic.lua

UI/InGame/WorldView/TradeLogic.lua
0439
oldCursor = UIManager:SetUICursor(0); -- make sure we start with the default cursor
0496
UIManager:SetUICursor(oldCursor); -- make sure we retrun the cursor to the previous state



The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.