Scripting - CUO Specific Functions

Here can find some information about Scripting functions that work with CUO

Map Related

Load Map Markers
Syntax	CUO.LoadMarkers()
Description:
Calls the LoadMarkers function on the CUO world map. The map must be open for this to work. use in your code like: # CUO.LoadMarkers() #
Returns	nothing
In Object:	CUO
Parameters:

Go to Map Marker
Syntax	CUO.GoToMarker(x, y)
Description:
Executes the GoToMarker function on the CUO world map passing the x and y you provided. The map must be open for this to work. use in your code like: # CUO.GoToMarker(100, 200) #
Returns	nothing
In Object:	CUO
Parameters:

FreeView for CUO Map
Syntax	CUO.FreeView(bool)
Description:
Executes the FreeView function on the CUO world map passing the bool you provided. The map must be open for this to work. use in your code like: # CUO.FreeView(True) #
Returns	nothing
In Object:	CUO
Parameters:

Close Treasure Map
Syntax	CUO.CloseTMap()
Description:
Finds the first Treasure Map gump on your screen and closes it. If a Treasure Map gump was found returns True, otherwise returns False. use in your code like: # CUO.CloseTMap() #
Returns	True if a Treasure map was closed, otherwise False
In Object:	CUO
Parameters:

Sets an option in the CUO Profile
Syntax	CUO.ProfilePropertySet(string propertyName, bool enable)
Description:
This was just an experiment to see if I could automate the changing of CUO properties. use in your code like: # CUO.ProfilePropertySet("fps", "80") #
Returns	Nothing
In Object:	CUO
Parameters:

Opens a Container at a specific location
Syntax	CUO.OpenContainerAt(Item bag, int x, int y)
Description:
Opens the specified container with the gump at the x, y provided. If already open nothing is done. use in your code like: # CUO.ProfilePropertySet("fps", "80") #
Returns	Nothing
In Object:	CUO
Parameters:

Sets the location the specified gump will open at
Syntax	CUO.SetGumpOpenLocation(uint gumpserial, int x, int y)
Description:
Changes the location the gump will open at use in your code like: # CUO.SetGumpOpenLocation(0x456789, 100, 200) #
Returns	Nothing
In Object:	CUO
Parameters:	gumpserial - the Serial id of the container	x - x coordinate on screen	y - y coordinate on screen

Moves a gump to a specified location
Syntax	CUO.MoveGump(uint serial, int x, int y)
Description:
Moves a gump on the screen.. Note: I dont think this is working. use in your code like: # CUO.MoveGump(0x456789, 100, 200) #
Returns	Nothing
In Object:	CUO
Parameters:	serial - the Serial id of the container	x - x coordinate on screen	y - y coordinate on screen

Show the player status bar at a specific location
Syntax	CUO.OpenMyStatusBar(int x, int y)
Description:
Opens the player status bar at the specified location. use in your code like: # CUO.OpenMyStatusBar(100, 200) #
Returns	Nothing
In Object:	CUO
Parameters:	x - x coordinate on screen	y - y coordinate on screen

Remove the player status bar
Syntax	CUO.CloseMyStatusBar()
Description:
Closes the player status bar. use in your code like: # CUO.CloseMyStatusBar() #
Returns	Nothing
In Object:	CUO
Parameters:

Open the health bar of a mobile at a specified screen location
Syntax	CUO.OpenMobileHealthBar(uint mobileserial, int x, int y, bool custom)
Description:
Opens a health bar for a mobile and places the gump at the specified location. use in your code like: # CUO.OpenMobileHealthBar(0x345678, 100, 200, False) #
Returns	Nothing
In Object:	CUO
Parameters:	uint mobileserial	int x	int y	bool custom - True - the CUO square “minimalist” gump vs False - the standard UO gump

Close the health bar of a mobile
Syntax	CUO.CloseMobileHealthBar(uint mobileserial)
Description:
Closes a health bar for a mobile. use in your code like: # CUO.CloseMobileHealthBar(0x345678) #
Returns	Nothing
In Object:	CUO
Parameters:	uint mobileserial

Play a CUO macro by name
Syntax	CUO.PlayMacro(string macroName)
Description:
WARNING Limited Testing: Attempts to play a CUO macro given its name. use in your code like: # CUO.PlayMacro("MyMacro") #
Returns	Nothing
In Object:	CUO
Parameters:	string macroName