Entities

Entities are the core piece of any game. An entity is any object in the physical world of the game can move, interacts with physics, and more. Examples of an Entity can be anything from the character controlled by a player, a shop NPC, a vehicle, a movable block or platform, and so much more.

In short, anything that is not a permanently immovable block that makes up a world's terrain is likely best suited to be created as an entity.

Flexibility

Entities are highly flexible. The HYTOPIA SDK exposes the ability to fully control all aspects of an entity, including the rigid body and collider(s) representation of an entity within the game engine. The SDK will automatically assume and infer sane defaults for entities, but allows you to override any of them.

You can learn more about the Rigid Body and Colliders used to represent the physical nature of an entity here.

Block Entities vs Model Entities

Entities are represented by either a GLTF (.gltf) format model from your assets folder - we call these Model Entities. Or, by a size and block texture, we call these Block Entities.

Model Entities - Model entities are great for characters, enemies, NPCs, animals, unique terrain models that interact with the world, and much more
Block Entities - Block entities are great for moving platforms, blocks that can be push/pulled for various puzzle or terrain traversing, and more.

Creating & Spawning An Entity

Here's an example of how to create and then spawn an Entity. An entity will not exist in the game until its .spawn() method is called. An entity can be despawned at any time with .despawn(). Once an entity is despawned, it can be respawned again with .spawn() .

startServer(world => {
  // Enable debug rendering so we can see the collider shape
  // of our entities. Please note that enabling this in a large
  // world or with many entities spawned will severely impact
  // game client performance. This is because the lines to draw
  // the physics collider representations are sent to the client
  // every tick, and with a large world and/or many colliders, this
  // can be many megabytes of data, sending 60 times per second,
  // choking the websocket even on a local connection.
  world.simulation.enableDebugRendering(true);

  // Create a block entity that spawns
  // or despawns every second
  const blockEntity = new Entity({
    blockTextureUri: 'textures/bricks.png', // A texture URI without a file extension will use a folder and look for the textures for each face in the folder (-x.png, +x.png, -y.png, +y.png, -z.png, +z.png)
    blockHalfExtents: { x: 0.5, y: 0.5, z: 0.5 },
    // The collider & rigid body will automatically be
    // inferred and created by the blockHalfExtents.
    // You may override this by using rigidBodyOptions.
    // blockHalfExtents will always represent the visual
    // size of the block entity, no matter its colliders.
  });
  
  setInterval(() => {
    if (blockEntity.isSpawned) {
      blockEntity.despawn();
    } else {
      blockEntity.spawn({ x: 4, y: 2, z: 6 });
    }
  }, 1000);
  
  // Create a skeleton entity (model entity)
  const skeletonEntity = new Entity({
    modelUri: 'models/skeleton.gltf',
    modelLoopedAnimations: [ 'idle' ],
    // Scale is the proportional model size relative 
    // to its size in its .gltf file
    modelScale: 1,
    // Note: For model entities, we have to explicitly define
    // at least 1 collider to represent the entity in the physics
    // simulation. In a later version of the HYTOPIA SDK, the 
    // default collider of a model relative to it's modelScale
    // will be automatically inferred, but is not currently.
    rigidBodyOptions: {
      type: RigidBodyType.DYNAMIC, // DYNAMIC means it participates in all physics interactions
      enabledRotations: { x: false, y: true, z: false }, // Only allow rotations around Y axis (Yaw)
      colliders: [
        {
          shape: ColliderShape.BLOCK,
          halfExtents: { x: 0.5, y: 1.4, z: 0.5 }, // 
        },
      ],
    },
  });
});

Next Steps

Entities are incredibly powerful and support a variety of features. We strongly recommend you check out the following guides to gain a better understanding of the different things you can do with entities.

PreviousChat & Commands NextAnimations

Last updated 26 days ago

startServer(world => { // Enable debug rendering so we can see the collider shape // of our entities. Please note that enabling this in a large // world or with many entities spawned will severely impact // game client performance. This is because the lines to draw // the physics collider representations are sent to the client // every tick, and with a large world and/or many colliders, this // can be many megabytes of data, sending 60 times per second, // choking the websocket even on a local connection. world.simulation.enableDebugRendering(true); // Create a block entity that spawns // or despawns every second const blockEntity = new Entity({ blockTextureUri: 'textures/bricks.png', // A texture URI without a file extension will use a folder and look for the textures for each face in the folder (-x.png, +x.png, -y.png, +y.png, -z.png, +z.png) blockHalfExtents: { x: 0.5, y: 0.5, z: 0.5 }, // The collider & rigid body will automatically be // inferred and created by the blockHalfExtents. // You may override this by using rigidBodyOptions. // blockHalfExtents will always represent the visual // size of the block entity, no matter its colliders. }); setInterval(() => { if (blockEntity.isSpawned) { blockEntity.despawn(); } else { blockEntity.spawn({ x: 4, y: 2, z: 6 }); } }, 1000); // Create a skeleton entity (model entity) const skeletonEntity = new Entity({ modelUri: 'models/skeleton.gltf', modelLoopedAnimations: [ 'idle' ], // Scale is the proportional model size relative // to its size in its .gltf file modelScale: 1, // Note: For model entities, we have to explicitly define // at least 1 collider to represent the entity in the physics // simulation. In a later version of the HYTOPIA SDK, the // default collider of a model relative to it's modelScale // will be automatically inferred, but is not currently. rigidBodyOptions: { type: RigidBodyType.DYNAMIC, // DYNAMIC means it participates in all physics interactions enabledRotations: { x: false, y: true, z: false }, // Only allow rotations around Y axis (Yaw) colliders: [ { shape: ColliderShape.BLOCK, halfExtents: { x: 0.5, y: 1.4, z: 0.5 }, // }, ], }, }); });