Gizmo <BadgeClient/>

Gizmo module is a specialized tool for manipulating entities in 3D space within RedM. It provides a visual interface for moving, rotating, and precisely positioning objects with optional camera controls.

Configuration Variables (Convars)

Configuration Variables (Convars) > Runtime Configuration

You can also override specific configuration options when calling jo.gizmo.moveEntity() by passing a configuration table as the second parameter:

local result = jo.gizmo.moveEntity(object, {
    enableCam = false,           -- Disable camera for this specific call
    maxDistance = 200,           -- Allow movement up to 200 units away
    movementSpeed = 0.2          -- Set faster movement speed for this instance
})

This allows for flexible configuration on a per-call basis without changing the server-wide defaults.

JO Functions > jo.gizmo.cancel()

<!-- @include: ./slots/headers.md#client|jo.gizmo.cancel -->

Cancels the currently active gizmo interface <br>

<!-- @include: ./slots/descriptions.md#client|jo.gizmo.cancel -->

JO Functions > jo.gizmo.cancel() > Syntax

jo.gizmo.cancel()

<!-- @include: ./slots/examples.md#client|jo.gizmo.cancel -->

<!-- @include: ./slots/footers.md#client|jo.gizmo.cancel -->

JO Functions > jo.gizmo.moveEntity()

<!-- @include: ./slots/headers.md#client|jo.gizmo.moveEntity -->

Setup a gizmo interface to move an entity in 3D space <br> Allows for precise positioning and rotation of entities through a visual interface <br> Uses a camera system for better manipulation when enabled <br>

<!-- @include: ./slots/descriptions.md#client|jo.gizmo.moveEntity -->

JO Functions > jo.gizmo.moveEntity() > Syntax

jo.gizmo.moveEntity(entity, cfg, allowPlace)

JO Functions > jo.gizmo.moveEntity() > Parameters

entity : integer

The entity to move

cfg : table <BadgeOptional />

Configuration options to override defaults

cfg.enableCam : boolean - Enable/disable camera feature - default based on config

cfg.maxDistance : number - Max distance the entity can be moved from starting position - default based on config

cfg.maxCamDistance : number - Max distance the camera can be moved from player - default based on config

cfg.minY : number - Min Y value from starting position for camera - default based on config

cfg.maxY : number - Max Y value from starting position for camera - default based on config

cfg.movementSpeed : number - Movement speed for camera - default based on config

cfg.allowTranslateX : boolean - Allow translation on X-axis - default true

cfg.allowTranslateY : boolean - Allow translation on Y-axis - default true

cfg.allowTranslateZ : boolean - Allow translation on Z-axis - default true

cfg.allowRotateX : boolean - Allow rotation on X-axis - default true

cfg.allowRotateY : boolean - Allow rotation on Y-axis - default true

cfg.allowRotateZ : boolean - Allow rotation on Z-axis - default true

cfg.allowSnapToGround : boolean - Allow snapping to ground - default true

cfg.rotationSnap : number - Rotation snap value - default 5

cfg.onMove : function - Optional function fired when the entity move with the gizmo

allowPlace : function <BadgeOptional />

Optional callback to validate placement - receives proposed position as parameter

JO Functions > jo.gizmo.moveEntity() > Return Value

Type : table|nil

Returns entity position and rotation data when completed, nil if already active

<!-- @include: ./slots/examples.md#client|jo.gizmo.moveEntity -->

<!-- @include: ./slots/footers.md#client|jo.gizmo.moveEntity -->

Configuration Variables (Convars)

JO Functions > jo.gizmo.moveEntity() > Parameters

entity : integer

The entity to move

cfg : table <BadgeOptional />

Configuration options to override defaults

cfg.enableCam : boolean - Enable/disable camera feature - default based on config

cfg.maxDistance : number - Max distance the entity can be moved from starting position - default based on config

cfg.maxCamDistance : number - Max distance the camera can be moved from player - default based on config

cfg.minY : number - Min Y value from starting position for camera - default based on config

cfg.maxY : number - Max Y value from starting position for camera - default based on config

cfg.movementSpeed : number - Movement speed for camera - default based on config

cfg.allowTranslateX : boolean - Allow translation on X-axis - default true

cfg.allowTranslateY : boolean - Allow translation on Y-axis - default true

cfg.allowTranslateZ : boolean - Allow translation on Z-axis - default true

cfg.allowRotateX : boolean - Allow rotation on X-axis - default true

cfg.allowRotateY : boolean - Allow rotation on Y-axis - default true

cfg.allowRotateZ : boolean - Allow rotation on Z-axis - default true

cfg.allowSnapToGround : boolean - Allow snapping to ground - default true

cfg.rotationSnap : number - Rotation snap value - default 5

cfg.onMove : function - Optional function fired when the entity move with the gizmo

cfg.onlyOnMove : boolean - Optional if onMove set the position or rotation will only be send to the function

allowPlace : function <BadgeOptional />

Optional callback to validate placement - receives proposed position as parameter