🌐Module Entities (Shared)

Le module Eko.Entities fournit un ensemble d’outils pour créer, manipuler et synchroniser les entités (objets, véhicules, peds). Il regroupe trois ensembles principaux :

• Actions: Opérations directes sur une entité existante.

• Create: Fabrique d’entités (spawn).

• Méthodes utilitaires diverses (ownership, contrôle, statebags).

---

📦 API

---

Eko.Entities:Wait(entity)

Attend que l’entité soit valide et chargée en mémoire.

• Paramètres

  • entity (integer): Handle de l’entité.

• Retour

  • boolean: true si disponible.

---

Eko.Entities:WaitForNetworkId(netId) -- Client uniquement

Attend qu’un network ID soit mappé sur un handle local.

• Paramètres

  • netId (integer): Network ID.

• Retour

  • integer | nil: Handle de l’entité ou nil si échec.

---

Eko.Entities:SetStatebag(entity, key, value)

Modifie un état synchronisé (statebag) sur l’entité.

• Paramètres

  • entity (integer): Entité cible.

  • key (string): Nom de la clé.

  • value (any): Valeur à affecter.

---

Eko.Entities:WaitUntilPlayerEqualsEntityOwner(entity, timeout) -- Client uniquement

Attend que le joueur local devienne propriétaire d’une entité.

• Paramètres

  • entity (integer): Entité.

  • timeout (integer): Durée maximum en ms.

• Retour

  • boolean: true si succès.

---

Eko.Entities:Control(entity, force?)

Tente de prendre le contrôle d’une entité réseau.

• Paramètres

  • entity (integer): Entité.

  • force (boolean, optionnel): Empêcher la migration après la prise de contrôle.

• Retour

  • boolean: true si contrôle obtenu.

---

Eko.Entities:WaitForOwnership(entity)

Attend que le script devienne propriétaire de l’entité.

• Paramètres

  • entity (integer): Entité.

• Retour

  • boolean: true si succès.

---

⚙️ Sous-module : EntityActions

Permet d’exécuter des actions sur une entité existante.

---

Eko.Entities.Actions:Move(entity, position)

Déplace une entité.

• Paramètres

  • entity (integer): ID local de l'entité

  • position (vector3 | vector4): Position.

---

Eko.Entities.Actions:Rotate(entity, rotation, rotation_order)

Applique une rotation.

• Paramètres

  • entity (integer): ID local de l'entité

  • rotation (_vector3): Rotation.

  • rotation_order (integer): Ordre de rotation

---

Eko.Entities.Actions:SetHeading(entity, heading)

Change le heading.

• Paramètres

  • entity (integer): ID local de l'entité

  • heading (number): Heading.

---

Eko.Entities.Actions:Delete(entity)

Supprime une entité.

• Paramètres

  • entity (integer): ID local de l'entité

---

Eko.Entities.Actions:PlaceOnGroundProperly(entity)

Replace une entité correctement au sol.

• Paramètres

  • entity (integer): ID local de l'entité

---

Eko.Entities.Actions:Detach(entity, dynamic, collision)

Détache une entité d’un parent.

• Paramètres

  • entity (integer): ID local de l'entité

  • dynamic (boolean): Si l'entité doit garder sa vitesse, ou s'arrêter.

  • collision (boolean): Si l'entité doit avoir ou non des collisions.

---

Eko.Entities.Actions:ToggleCollision(entity, toggle, keepPhysics)

Active/désactive la collision.

• Paramètres

  • entity (integer): ID local de l'entité

  • toggle (boolean): Active / Désactive les collisions.

  • keepPhysics (boolean): Si l'entité doit garder ou non de la physique.

---

Eko.Entities.Actions:RenderScorched(entity, toggle)

Applique un effet brûlé.

• Paramètres

  • entity (integer): ID local de l'entité

  • toggle (boolean): Active / Désactive l'effet.

---

Eko.Entities.Actions:Attach(entity, target, boneIndex, offset, rotation, collision, is_ped, rotation_order, sync_rotation)

Attache une entité à une autre.

• Paramètres

  • entity (integer): ID local de l'entité

  • target (integer): ID local de l'entité cible.

  • boneIndex (integer): Index de l'os du squelette sur lequel l'entité sera attachée.

  • offset (vector3): Décalage par rapport a la position initiale de l'os

  • rotation (vector3): Rotation à appliquer à l'entité

  • collision (boolean): Si l'entité attachée doit avoir ou non des collisions

  • is_ped (boolean): Si l'entité attachée est un ped ou non

  • rotation_order (integer): Ordre de rotation

  • sync_rotation (boolean): Si la rotation de l'entité doit être calquée sur celles de l'entité sur laquelle elle est attachée ou non

---

🏗️ Sous-module : EntityFactory

Permet de créer des entités en jeu.

---

Eko.Entities.Create:Object(model, coords, networked, bucket?)

Crée un objet.

• Paramètres

  • model (string | integer): Nom ou hash du modèle.

  • coords (vector3 | vector4): Position.

  • networked (boolean): Si true, partagé réseau.

  • bucket (number, optionnel): Routing bucket.

• Retour

  • integer | nil: Handle de l’entité.

---

Eko.Entities.Create:Ped(model, coords, networked, bucket?)

Crée un ped.

• Paramètres

  • model (string | integer): Nom ou hash du modèle.

  • coords (vector3 | vector4): Position.

  • networked (boolean): Si true, partagé réseau.

  • bucket (number, optionnel): Routing bucket.

• Retour

  • integer | nil: Handle de l’entité.

---

Eko.Entities.Create:Vehicle(model, coords, networked, bucket?)

Crée un véhicule.

• Paramètres

  • model (string | integer): Nom ou hash du modèle.

  • coords (vector3 | vector4): Position.

  • networked (boolean): Si true, partagé réseau.

  • bucket (number, optionnel): Routing bucket.

• Retour

  • integer | nil: Handle de l’entité.

---

🛠️ Exemple d’utilisation

-- Créer un véhicule networké
local veh = Eko.Entities.Create:Vehicle("adder", vector3(0,0,72), true)
if veh then
    print("Véhicule créé:", veh)
end

-- Déplacer un objet
Eko.Entities.Actions:Move(veh, vector3(10,10,72))

-- Détacher l’objet
Eko.Entities.Actions:Detach(veh, true, true)

-- Prendre le contrôle
if Eko.Entities:Control(veh) then
    print("Contrôle pris")
end

-- Modifier un statebag
Eko.Entities:SetStatebag(veh, "customProp", true)

---

⚠️ Notes

• Ces méthodes sont disponibles côté client et côté serveur.

• Le contrôle et la propriété des entités nécessitent une synchronisation réseau.

• Les entités créées sans networked = true ne seront pas visibles pour les autres joueurs.