uimod3d.attach

Overview

• Attaches a Cohtml HTML view on a 3D plane mesh to the specified actor. The plane renders the HTML content as a texture in world space.

Metadata

Field	Value
Display	Attach 3D UI Mod
Category	uimod3d
Access	Public
Scope	B1Standalone
Tags	—
Aliases	—

Parameters

Name	Type	Required	Default	Description
entity_id	entityId	no	—	Target actor entity_id (defaults to possessed Zoi)
url	string	yes	—	Cohtml URL to load (e.g. coui://mymod/ui/app/index.html)
width	int	no	1024	Cohtml view width in pixels
height	int	no	1024	Cohtml view height in pixels
offset_x	float	no	0	X offset from actor origin (cm)
offset_y	float	no	0	Y offset from actor origin (cm)
offset_z	float	no	150	Z offset from actor origin (cm)
pitch	float	no	0	Pitch rotation (degrees)
yaw	float	no	0	Yaw rotation (degrees)
roll	float	no	0	Roll rotation (degrees)
scale_x	float	no	1	Scale along X axis
scale_y	float	no	1	Scale along Y axis
scale_z	float	no	1	Scale along Z axis
mesh_scale	float	no	0.5	Base mesh scale (0.5 = 50cm plane)

Returns

• Return shape is not declared for this command.

Usage

await inzoi.cli.execute('uimod3d.attach', {
  entity_id: 0, // optional
  url: '',
  width: 1024, // optional
  height: 1024, // optional
  offset_x: 0, // optional
  offset_y: 0, // optional
  offset_z: 150, // optional
  pitch: 0, // optional
  yaw: 0, // optional
  roll: 0, // optional
  scale_x: 1, // optional
  scale_y: 1, // optional
  scale_z: 1, // optional
  mesh_scale: 0.5, // optional
});