ENT Structure

From Garry's Mod
Jump to: navigation, search
Information about the ENT structure.

To learn more about scripted entities, see this page.
For list of callbacks, see ENT Hooks.

While some of the fields may be serverside or clientside only, it is recommended to provide them on both so addons could use their values.

Type Name Description
string Base

The base entity to derive from. This must be a valid Lua entity

string Type

Type of the entity. This must be one of these:

  • anim
  • brush
  • point
  • ai
  • nextbot
  • filter

See Scripted Entities for a more detailed explanation of what each one is.

string ClassName

Entity class name of the ENT (File or folder name of your ENT). This is set automatically after the entity file is loaded.

string Folder

The folder from where the entity was loaded. This should always be "entity/ent_myentity", regardless whether your ENT is stored as a file, or multiple files in a folder. This is set automatically before the entity file is loaded.

boolean AutomaticFrameAdvance

(Clientside) Set this to true if your entity has animations.

Default: false

string Category

(Clientside) Category the ENT is in

Default: Other

boolean Spawnable

Whether this ENT should be displayed in the Q menu

Default: false

boolean Editable

Whether the entity supports Editing. See Editable Entities for more info.

Default: false

boolean AdminOnly

Whether or not only admins can spawn the ENT from their Q menu

Default: false

string PrintName

(Clientside) Nice name of the ENT

Default: ""

string Author

(Clientside) The author of the ENT

Default: ""

string Contact

(Clientside) The contacts of the ENT creator

Default: ""

string Purpose

(Clientside) The purpose of the ENT creation

Default: ""

string Instructions

(Clientside) How to use your entity

Default: ""

number RenderGroup

(Clientside) The SENT's render group, see RENDERGROUP_ Enums.

Default: RENDERGROUP_OPAQUE

boolean DisableDuplicator

(Serverside) Disable the ability for players to duplicate this SENT.

Default: false

string ScriptedEntityType

(Clientside) Sets the spawnmenu content icon type for the entity, used by spawnmenu in the Sandbox-derived gamemodes. See spawnmenu.AddContentType for more information.

Default: "entity"

Personal tools
Navigation