Player

Indicates the player that the user plays.

---

Methods

isNear

public

Verify that the GameObject and other GameObject are within a certain distance.

Usage

const player = await gamium.player(By.path('Object path'));
await player.isNear(By.path('Another object path'), { epsilon: 10 });

Arguments

• otherLocator Locator

• option object

  • epsilon number

Returns

• Promise<boolean>

---

move

public

Move the Player to a specific position.

Usage

const player = await gamium.player(By.path('Object path'));
await player.move(By.path('Camera object path'), By.path('Dest Object path'), {
  by: MovePlayerBy.Navigation,
});

Arguments

• cameraLocator Locator

• dest Vector3 | Locator

• options Partial<MovePlayerOptions>

Returns

• Promise<void>

---

refresh

public

Updates the information that the object has.

Usage

const player = await gamium.player(By.path('Object path'));
await player.refresh();

Returns

• Promise<void>

---

Properties

info ObjectInfo

---