usePlayerState

The return value is an array with two values: - state: any - setState: (value: any, reliable?: boolean) => void

If reliable is true, the state is synced reliably to all players via Websockets. This is useful for game state that is critical to the game, like the winner.

If reliable is false, the state is synced via WebRTC, which is faster but less reliable. This is useful for game state that is not critical to the game, like the player’s current position (you can always rely on next position update).

Signature

function usePlayerState<T = any>(player: PlayerState, key: string, defaultValue: T): [T, (value: T, reliable?: boolean) => void]

Parameters

Returns

[T, (value: T, reliable?: boolean) => void]

Usage

import { usePlayerState } from 'playroomkit'
 
function PlayerComponent({ player }) {
  const [score, setScore] = usePlayerState(player, 'score', 0);
 
  return (
    <div>
      <p>Player {player.id} Score: {score}</p>
      <button onClick={() => setScore(score + 1)}>
        Add Point
      </button>
    </div>
  );
}