Types

A unique name for the menu. If not specified, the name will be set to the generated id.

The type of target to render. Specify one of the target types.

A table of items or a function that returns a table of items every ≈100ms.

Override the default behavior of Config.HideOnAction for this specific menu.

If the menu has no items, this can be used to perform a callback when clicking the menu star itself. The returned value will be used to determine whether the menu should be hidden after the action is performed.

Marks the target as stateful, meaning that if stateful is set to false, it will not render the inner star cicle, however if it's set to true it'll render a larger star (as defined in Config.Graphics.Star.StateSize)

The favicon to display at the center of the star. A texture object can be specified to render a specific ingame texture (like that of a ped headshot).

An optional help text to display over the target star. Will be hidden if the star is hovered.

Draws a linestrip from the center of the star to the specified point (vector or entity handle).

Multiple targets with the same uniqueKey will only render the closest one.

If set to true, the target star will be rendered even if something is visually obstructing it.

Override maximum distance at which the target can be interacted with.

Override render distance of the target.

Override overall scale of the target (i.e. the size of the target star and the size of the menu) This cannot be above 1, it is only possible to scale the menu down.

Override only the size of the target star, and not the menu. This cannot be above 1, it is only possible to scale the star down.

Set a tint (RGB) for the target star.

Show the target star even if the player is not holding down the interact keybind (Left Alt by default). This will cause Vivum Target to not be able to idle, making the CPU usage higher at all times.

Always have the target in a interactable (hovered) state. This can be used to make a general target for when a player is inside a vehicle, for example.

A callback that is called every ≈100ms to do additional calculations. Returning a new menu will replace the current menu (i.e. changing Menu.items or Menu.stateful).

The compatibility layer that was used when creating the target. Do not set this yourself.

Optional name to reference the item by. Item.label will be used if not specified.

The favicon to display left of the label. A texture object can be specified to render a specific ingame texture (like that of a ped headshot).

The theming of the item. Any value specified in Config.Graphics.Menu.Styles will work.

The returned value will be used to determine whether the menu should be hidden after the action is performed. If nil or true is returned, the menu will be hidden (If Config.HideOnAction is set to true), if false is returned it will ignore the Config.HideOnAction setting.

Override maximum distance at which the item can be interacted with.

The bone name or bone index to position the star at. If multiple bones are specified, the first valid one will be used.

The offset to apply to the star positioning (will be added after the bone position if specified)

If set to true, the entity can be hovered in addition to the detached star when used with positioning properties like bone or offset.

Offset relative to the entity, meaning X is left/right, Y is forward/backward, and Z is up/down.

Offset in absolute world coordinates. Meaning that the offset will remain constant independent of the entity's rotation.

The normalized difference between the entity coordinates and the offsets (bones, relative and absolute offsets). Skips the Z (up/down) component.

A function to mutate the offset with external logic. This function will be called every frame and as such must only be used in an integration in the vivum-target/integrations folder.

A handle to an entity to take the position from.

The position to draw the linestrip to, this will be overriden if entity is specified.

Offset of the entity coords or specified position.

If not specified, the txd will be set to the same value as txn.

Defaults to 1.

Defaults to 1.

If true, draws a red debug box while interacting.

If true, draws a red debug poly while interacting.

If true, draws a red debug sphere while interacting.

The entity handle.

Optionally filter the global target with a model.

Keep rendering the target (will only be visible if the target has bone or offset specified) on the last entity that was raycasted.