Text

R6 class to represent a text object in the Phaser scene, allowing dynamic updates to its content. Created with PhaserGame$add_text() method.

Methods

Public methods

• Text$new()

• Text$set()

• Text$show()

• Text$hide()

• Text$follow_camera()

• Text$stop_camera_follow()

• Text$set_scroll_factor()

• Text$set_depth()

• Text$clone()

---

Method new()

Create a text object in the Phaser scene.

Usage

Text$new(
  text,
  id,
  x,
  y,
  style,
  visible = TRUE,
  session = shiny::getDefaultReactiveDomain()
)

Arguments

text

Character. Text value to display.

id

Character. Unique ID for the text object.

x

Numeric. X-coordinate in pixels.

y

Numeric. Y-coordinate in pixels.

style

Named list. Styling options passed to Phaser text rendering.

visible

Logical. Whether text is initially visible.

session

Shiny session object.

---

Method set()

Update the text content of this object.

Usage

Text$set(text)

Arguments

text

Character. New text value to display.

---

Method show()

Show a previously added text object.

Usage

Text$show()

---

Method hide()

Hide a previously added text object.

Usage

Text$hide()

---

Method follow_camera()

Make the camera follow this text object as it moves through the world.

Usage

Text$follow_camera(lerp_x = 1, lerp_y = 1, round_pixels = TRUE)

Arguments

lerp_x

Numeric. Horizontal interpolation factor from 0 to 1 (default: 1).

lerp_y

Numeric. Vertical interpolation factor from 0 to 1 (default: 1).

round_pixels

Logical. Whether to round camera pixels to avoid sub-pixel rendering (default: TRUE).

---

Method stop_camera_follow()

Stop the camera from following this text object.

Usage

Text$stop_camera_follow()

---

Method set_scroll_factor()

Set how much this text object scrolls with the camera.

Usage

Text$set_scroll_factor(x, y = x)

Arguments

x

Numeric. Horizontal scroll factor (0 = fixed to viewport, 1 = scrolls with world).

y

Numeric. Vertical scroll factor. Defaults to x.

---

Method set_depth()

Set the text object's rendering depth. Objects with a larger depth are rendered in front of objects with a smaller depth.

Usage

Text$set_depth(depth)

Arguments

depth

Numeric. Phaser rendering depth.

Details

Every individually renderable object wrapper supports set_depth(). Larger values draw in front of smaller values. The method invisibly returns its object, so it can be chained with other object methods.

Returns

This text object, invisibly, to support method chaining.

Examples

\dontrun{
background <- game$add_image(
  "background", "assets/background.png", x = 400, y = 300
)
background$set_depth(-10)

control <- game$add_rectangle(
  "jump_control", x = 720, y = 540, width = 120, height = 48,
  color = "0x223344"
)
control$set_depth(50)$set_scroll_factor(0)

label <- game$add_text("Jump", "jump_label", x = 690, y = 528)
label$set_depth(51)$set_scroll_factor(0)
}

---

Method clone()

The objects of this class are cloneable with this method.

Usage

Text$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## ------------------------------------------------
## Method `Text$set_depth`
## ------------------------------------------------

if (FALSE) { # \dontrun{
background <- game$add_image(
  "background", "assets/background.png", x = 400, y = 300
)
background$set_depth(-10)

control <- game$add_rectangle(
  "jump_control", x = 720, y = 540, width = 120, height = 48,
  color = "0x223344"
)
control$set_depth(50)$set_scroll_factor(0)

label <- game$add_text("Jump", "jump_label", x = 690, y = 528)
label$set_depth(51)$set_scroll_factor(0)
} # }