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 entity (File or folder name of your entity). 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 entity 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. You should also apply changes to the ENTITY:Think function from the example on that page.

Default: false

string Category

(Clientside) Spawnmenu category to put the entity into

Default: Other

boolean Spawnable

Whether this entity should be displayed and is spawnable in the spawn 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 entity from their spawn menu

Default: false

string PrintName

(Clientside) Nice name of the entity to appear in the spawn menu

Default: ""

string Author

(Clientside) The author of the entity

Default: ""

string Contact

(Clientside) The contacts of the entity creator

Default: ""

string Purpose

(Clientside) The purpose of the entity creation

Default: ""

string Instructions

(Clientside) How to use your entity

Default: ""

number RenderGroup

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

Default: RENDERGROUP_OPAQUE

boolean DisableDuplicator

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

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