Skip to main content

Function: useGameEntity()

useGameEntity<T>(gameObject): T

Defined in: packages/core/src/hooks/useGameEntity.ts:58

Monitors changes to a given game entity by wrapping it in a Valtio proxy. This hook enables React components to automatically re-render when the entity's state changes.

Type Parameters​

T​

T extends BaseGameObject<InitVarsType>

Parameters​

gameObject​

T

The game entity to observe. Must extend BaseGameObject and be registered.

Returns​

T

The proxied game entity that triggers re-renders on state changes.

Example​

import { useGameEntity } from "@app/hooks";
import { environment } from "@game/entities/environment";

function TemperatureDisplay() {
  const env = useGameEntity(environment);
  return <div>Temperature: {env.variables.temperature}°C</div>;
}