UIElement

---

Methods

click

public

Click UIElement.

Usage

const okButton = await ui.find(By.path('Object path'));
await gamium.wait(Until.elementInteractable(okButton));
await okButton.click();

Arguments

• options Partial<ActionsClickOptions>

Returns

• Promise<void>

---

drag

public

Drag the UIElement.

Usage

const handle = await ui.find(By.path('Object path'));
await gamium.wait(Until.elementInteractable(handle));
await handle.drag(
  {
    x: handle.gameObject.info.screenPosition.x - 30,
    y: handle.gameObject.info.screenPosition.y,
  },
  { durationMs: 1000, intervalMs: 100 },
);

Arguments

• to UIElement | Vector2

• options Partial<ActionsDragOptions>

Returns

• Promise<void>

---

getText

public

Import text if it is a UIElement that has text.

Usage

const questObject = await ui.find(By.path('Object path'));
const progress = questObject.getText();

Returns

• Promise<string>

---

isInteractable

public

Verify that UIElement is interactive. To return to true, you must pass a number of conditions. Option allows you to override some conditions.

Usage

const okButton = await ui.find(By.path('Object path'));
const isInteractable = await okButton.isInteractable();

Arguments

• options Partial<QueryObjectInteractableOptions>

Returns

• Promise<boolean>

---

refresh

public

Updates the information that the object has.

Usage

const okButton = await ui.find(By.path('Object path'));
await okButton.refresh();

Returns

• Promise<void>

---

scroll

public

Scroll by delta from UIElement.

Usage

const dragger = await ui.find(By.path('Object path'));
await gamium.wait(Until.elementInteractable(dragger));
await dragger.scroll({ x: 0, y: -0.5 }, { durationMs: 2000 });

Arguments

• delta Vector2

• options Partial<ActionsScrollOptions>

Returns

• Promise<void>

---

setText

public

Enter text in UIElement.

Usage

const text1 = await ui.find(By.path('Object path'));
await text1.setText('Hello World').perform();

Arguments

• text string

• options

Returns

• Promise<void>

---

tryIsInteractable

public

Arguments

• options Partial<QueryObjectInteractableOptions>

Returns

• Promise<TryResult<boolean>>

---

tryWaitInteractable

public

Arguments

• options Partial<QueryObjectInteractableOptions>

Returns

• Promise<TryResult<void>>

---

waitInteractable

public

Wait for UIElement to interact..

Usage

const okButton = await ui.find(By.path('Object path'));
await okButton.waitInteractable();

Arguments

• options Partial<QueryObjectInteractableOptions>

Returns

• Promise<void>

---

Properties

info ObjectInfo

---