Skip to main content

uimod3d.transform

Overview

  • Adjusts the position, rotation, or scale of a 3D UI attached to an actor. Only specified parameters are modified; others keep their current values.

Metadata

FieldValue
DisplayTransform 3D UI Mod
Categoryuimod3d
AccessPublic
ScopeB1Standalone
Tags
Aliases

Parameters

NameTypeRequiredDefaultDescription
entity_identityIdnoTarget actor entity_id
offset_xfloatnoX offset from actor origin (cm)
offset_yfloatnoY offset from actor origin (cm)
offset_zfloatnoZ offset from actor origin (cm)
pitchfloatnoPitch rotation (degrees)
yawfloatnoYaw rotation (degrees)
rollfloatnoRoll rotation (degrees)
scalefloatnoUniform scale (overridden by scale_x/y/z)
scale_xfloatnoScale along X axis
scale_yfloatnoScale along Y axis
scale_zfloatnoScale along Z axis

Returns

  • Return shape is not declared for this command.

Usage

await inzoi.cli.execute('uimod3d.transform', {
entity_id: 0, // optional
offset_x: 0.0, // optional
offset_y: 0.0, // optional
offset_z: 0.0, // optional
pitch: 0.0, // optional
yaw: 0.0, // optional
roll: 0.0, // optional
scale: 0.0, // optional
scale_x: 0.0, // optional
scale_y: 0.0, // optional
scale_z: 0.0, // optional
});