en-target

en-target is EndCore's "third eye". Players hold Left Alt, look at a ped, another player, a vehicle, an object or a spot in the world, and a short list of options appears beside the reticle. The mouse wheel moves through the list; left-click or E picks an option.

The camera keeps moving while you look, because en-target never takes NUI focus. Vehicles and objects under the reticle get an orange outline (peds are not outlined). Looking is blocked while you are dead, in the pause menu, focused on another NUI, or not logged in to a character.

#At a glance

#How it works

While the look key is held (or toggled on), en-target casts a ray from the camera every Config.tickRate milliseconds. It collects the options that apply to whatever the ray hits:

• Global options for every ped, player, vehicle or object.
• Model options for specific model names or hashes.
• Local entity options for specific entity handles you pass in.
• Sphere zones placed at world coordinates.

Each option is then filtered by its own distance, bones, groups, items and canInteract checks. Only options that pass are shown. When the player picks one, looking stops first and then the action runs.

Options are tracked per registering resource and removed automatically when that resource stops. Deleted local entities are purged every 10 seconds.

#Restart safety

If you register through the library wrapper encore.target.*, global, model and zone registrations are remembered and re-applied whenever en-target starts or restarts. Local entity registrations are not remembered across an en-target restart, so register those again when needed.

If en-target is not running, nothing shows. A resource that must keep working without it should fall back to encore.showPrompt. See Target interface.

#Configuration

config/client.lua:

-- config/client.lua: press Alt once to start looking, again to stop
Config.key = 'LMENU'
Config.toggle = true
Config.rayLength = 10.0

#Option shape

Every export takes one option or a list of options.

{
    name = 'my-res:action',     -- unique; the same name replaces. Default '<resource>:<label>'
    label = 'Do thing',
    icon = 'box',               -- en-ui icon name
    distance = 2.0,             -- player-to-look-point distance
    bones = { 'boot' },         -- entity bones; nearest within Config.boneRadius
    groups = { medic = 2 },     -- see below
    items = 'lockpick',         -- see below
    canInteract = function(entity, distance, coords, name, bone) return true end,
    onSelect = function(data) end, -- data = { name, label, entity, coords, distance, zone, bone }
    -- used only when onSelect is absent, checked in this order:
    event = 'client:event',        -- TriggerEvent(event, data)
    serverEvent = 'server:event',  -- TriggerServerEvent; data.entity becomes a network id (0 if not networked)
    command = 'somecommand',       -- ExecuteCommand
}

groups is checked against the player's job name and grade from exports['en-core']:GetPlayerData(), or their player group. items is checked with encore.inventory.getItemCount.

#Exports

Client exports on exports['en-target']:

Calling a Remove* export with no names clears every option in that list.

#encore.target wrapper

Prefer the library wrapper from en-core. It survives en-target restarts (except local entities) and runs onSelect in its own thread inside your resource, so your handler may wait on callbacks or progress bars.

#Events

en-target has no events of its own. It stops looking when it receives encore:client:playerUnloaded or encore:client:playerDied.

#Examples

A searchable vending machine that needs a lockpick, and a radio tower anyone in a player group can use:

-- client.lua
encore.target.addModel({ 'prop_vend_snack_01', 'prop_vend_soda_01' }, {
    name = 'my-scav:vending',
    label = 'Search vending machine',
    icon = 'search',
    distance = 1.8,
    items = 'lockpick',
    canInteract = function(entity) return not Entity(entity).state.searched end,
    onSelect = function(data)
        local ok = encore.callback.await('my-scav:search', NetworkGetNetworkIdFromEntity(data.entity))
    end,
})

encore.target.addSphereZone({
    name = 'my-scav:radio_tower',
    coords = vec3(750.2, 1300.5, 360.3),
    radius = 1.5,
    options = {
        { name = 'my-scav:broadcast', label = 'Use radio', icon = 'radio', groups = 'group', onSelect = function() end },
    },
})

Turn looking off during a scripted scene:

exports['en-target']:Disable(true)
-- ... scene ...
exports['en-target']:Disable(false)

#Related

• Target interface
• Icons
• Groups
• en-inventory