REC_EntityManager
Stracture
Installation, configuration, and usage for REC_EntityManager.
- Added
- Updated
The following configuration files and manifest are taken from the current source.
config/sh_config.lua
---[[
--- REC_EntityManager shared config
--- The tracking settings live in config/sv_config.lua: they are read on the
--- server only, and this file also loads on the client.
--- What each setting does, and why the defaults are what they are:
--- https://docs.re-cord.dev/en/resources/rec_entitymanager
---]]
---@type REC_Library.Client.API, REC_Library.Shared.API
local clApi, shApi = require "@REC_Library.client.cl_api", require "@REC_Library.shared.sh_api"
local apiEnums = shApi.Enums
local zoneTypes = apiEnums.ZoneType
---@class REC_EntityManager.Shared.Config
local config = {}
---[[
--- List of objects to be placed
---]]
---@type table<string, REC_EntityManager.Shared.Config.PlacedZone>
config.placedZones = {
-- Example:
-- ["example"] = {
-- type = zoneTypes.SphereZone,
-- coords = vector3(-919.61, -730.68, 19.92),
-- radius = 100.0,
-- entities = {
-- {
-- model = "prop_rock_1_d",
-- coords = vector3(-926.9, -735.22, 19.93),
-- heading = 20.49,
-- },
-- },
-- },
}
---[[
--- List of existing entities to be destroyed
---]]
---@type table<string, REC_EntityManager.Shared.Config.DestroyZone>
config.destroyZones = {
-- ["bank"] = {
-- type = zoneTypes.SphereZone,
-- coords = vector3(-1210.73, -335.61, 37.78),
-- radius = 100.0,
-- exteriors = {
-- -- Example:
-- {
-- model = "v_ilev_genbankdoor1",
-- coords = vector3(-1214.63, -328.08, 37.8),
-- },
-- {
-- model = "v_ilev_genbankdoor2",
-- coords = vector3(-1214.02, -327.76, 37.56),
-- },
-- },
-- interiors = {
-- -- Example:
-- {
-- model = "v_ilev_gb_teldr",
-- coords = vector3(-1215.2, -334.23, 37.86)
-- },
-- {
-- model = "v_ilev_gb_vauldr",
-- coords = vector3(-1210.73, -335.61, 37.78),
-- },
-- },
-- },
}
---[[
--- Blacklist of entity
---]]
---@type REC_EntityManager.Shared.Config.blacklistModels
config.blacklistModels = {
objects = {
},
peds = {
-- "U_M_M_Jesus_01",
-- "A_F_Y_Hipster_01",
},
vehicles = {
-- "pyro",
-- "strikeforce",
},
}
---[[
--- Debug Mode
---]]
---@type boolean
config.debugMode = true
return config
---@class REC_EntityManager.Shared.Config.PlacedZone
---@field type REC_Library.Shared.Enums.ZoneType
---@field coords vector3
---@field radius? number
---@field tickness? number
---@field entities REC_EntityManager.Shared.Config.PlacedZone.Entity[]
---@class REC_EntityManager.Shared.Config.PlacedZone.Entity
---@field model string
---@field coords vector3
---@field heading number
---@class REC_EntityManager.Shared.Config.DestroyZone
---@field type REC_Library.Shared.Enums.ZoneType
---@field coords vector3
---@field radius? number
---@field tickness? number
---@field exteriors REC_EntityManager.Shared.Config.DestroyZone.DestroyExistingEntity[]
---@field interiors REC_EntityManager.Shared.Config.DestroyZone.DestroyExistingEntity[]
---@class REC_EntityManager.Shared.Config.DestroyZone.DestroyExistingEntity
---@field model string|integer
---@field coords vector3
---@field searchRadius? number
---@class REC_EntityManager.Shared.Config.blacklistModels
---@field objects string[]
---@field peds string[]
---@field vehicles string[]
