LogoLogo
CtrlK
  • Introduction
  • sdks
    • Feature Comparison
    • Unity
    • Godot
    • Defold
    • LÖVE
    • Unreal
  • Quick Start
    • Unity
    • Godot
    • Defold
    • LÖVE
    • Unreal
  • Server Side
    • Entities
    • Chunks
    • Players
    • Dimensions
    • Events
    • Logging
    • Lua Environment
    • Git Primer
    • Physics
  • HTTP API
    • Authentication
    • Player API
  • Api Reference
    • Entity API
      • Create
      • Message
      • Entity
        • Fields
          • ID
          • Type
          • Data
          • Chunkloader
          • Transient
        • Methods
          • Move
          • MoveTo
          • GetPosition
          • Remove
          • GetNearbyEntities
          • Warp
        • Necessary Methods
          • init
          • update
          • message
    • Chunk API
      • Chunk
        • Fields
          • ID
          • X
          • Y
          • Size
          • Generated
          • Dimension
          • Data
        • Necessary Methods
          • init
    • Client API
      • Message
    • Dimension API
      • Create
      • Delete
      • List
    • Events API
      • on_player_join
      • on_player_leave
    • Table API
      • Append
      • Remove
      • Join
    • Util API
      • Time
      • TimeMillis
    • HTTP Request API
      • Get
      • Post
      • Put
      • Delete
    • Physics API
      • NewBody
      • NewBoxShape
      • NewSphereShape
  • Template Projects
    • Rust Realm (MMO by BiteMe Games)
Powered by GitBook
On this page
  1. Api Reference
  2. Entity API
  3. Entity

Fields

entity.

Field
Type
Description

ID

string

UUID of the entity. Read-only.

Type

string

Type of the entity. Read-only.

Data

table

A custom Lua table which can be used to store any data about the entity.

Chunkloader (Premium Only)

bool

If true, the chunk containing this entity will remain loaded even if no players are present.

Transient

bool

If true, when the chunk containing this entity is unloaded, the entity will be removed.

PreviousEntityNextID

Last updated 4 days ago