UI
UI Controling has a description. Class for easy UI manipulation.
Methods
click
public
Wait for the specified object to be found through Locator
. If the object is found, wait until interaction is possible. Click if interaction is possible.
Usage
ui.click(By.path('Object path'))
Arguments
locator
Locator
find_options
FindObjectOptions
click_options
ActionClickOptions
drag
public
Wait for the specified object to be found through Locator
. If the object is found, wait until interaction is possible. If interaction is possible, start the drag.
Usage
ui.drag(By.path('Object path'), Vector2(0, 0))
Arguments
locator
Locator
find_options
FindObjectOptions
drag_options
ActionDragOptions
find
public
Wait for the specified object to be found through Locator
. If an object is found, it is considered to be UIElement
and returns the object
Usage
elem = ui.find(By.path('Object path'))
Arguments
locator
Locator
options
FindObjectOptions
Return
finds
public
Finds the objects specified through Locator
. If the objects are found, consider them as UIelement
and return the objects
Usage
elems = ui.finds(By.path('Object path'))
Arguments
locator
Locator
options
FindObjectOptions
Return
get_text
public
Wait for the specified object to be found through Locator
. If the object is found, wait until interaction is possible. Returns Text if interaction is possible and Text exists.
Usage
progress = ui.get_text(By.path('Object path'))
Arguments
locator
Locator
find_options
FindObjectOptions
scroll
public
Wait for the specified object to be found through 'Locator'. If the object is found, wait until interaction is possible. Start scrolling if interaction is possible.
Usage
ui.scroll(By.path('Object path'), Vector2(0, -0.1 ))
Arguments
locator
Locator
delta
Vector2
find_options
FindObjectOptions
scroll_options
ActionScrollOptions
set_text
public
Wait for the specified object to be found through 'Locator'. If the object is found, wait until interaction is possible. If you can interact and type Text, type Text.
Usage
ui.set_text(By.path('Object path'), 'Hello, World!')
Arguments
locator
Locator
text
str
find_options
FindObjectOptions
try_find
public
Arguments
locator
Locator
options
FindObjectOptions
Return
TryResult
[UIElement
]
try_finds
public
Arguments
locator
Locator
options
FindObjectOptions