Network sync: claim (distributed authority) (net.claim) #

What it is for #

Shares authority between players by claim: each client simulates the objects it has claimed, such as its avatar or a car it drives, while the server only arbitrates and everything else is shown interpolated.

It needs net.transport, game.engine; installing it brings them in.

Turn it on #

Install the kit in a project, then change a setting (the values shown are its defaults):

gripforge_gamekit_install   { project_id: "gkp_…", id: "net.claim" }
gripforge_gamekit_configure { project_id: "gkp_…", id: "net.claim",
                              config: { "snapshotHz": 20, "publishHz": 20 } }

First example #

<!-- test: kits/net_claim/tests/net_claim.rs::connecting_publishes_the_player_as_a_locked_avatar_once --> This is the body of the passing test connecting_publishes_the_player_as_a_locked_avatar_once; the helper functions it calls are defined at the top of the same test file.

#[test]
fn connecting_publishes_the_player_as_a_locked_avatar_once() {
    let mut s = online(json!({}));
    player(&mut s, 1.0, 2.0);
    answer(&mut s, "c:create", json!(40));
    connect(&mut s, 3);
    let sent = commands(&mut s);
    let creates: Vec<&Json> = sent.iter().filter(|c| c["c"] == "create").collect();
    assert_eq!(creates.len(), 1);
    assert_eq!(creates[0]["state"]["p"], json!([1, 0, 2]));
    assert_eq!(creates[0]["state"]["d"], json!({ "kind": "avatar" }));
    assert_eq!(creates[0]["lock"], true);
    assert_eq!(call(&mut s, KIT, "netIdOf", json!(["e1"])), json!(40));
    assert_eq!(call(&mut s, KIT, "entityOf", json!([40])), json!("e1"));
    step(&mut s, 2);
    assert!(
        commands(&mut s).iter().all(|c| c["c"] != "create"),
        "never created twice"
    );
}

Settings and defaults #

Descriptions come from the kit manifest and stay in English.

Services, events, variables #

• Service net.sync: The project replication model (one per project: the net.* sync kits conflict with each other).
• Service net.claim: claim(entity, priority) / release(entity) / isOwner(entity) / create(state); ownership events.
• Events emitted:
  • net.owner (entity, netId, owner, mine) — Ownership of a replicated object changed.
  • net.denied (entity, netId, why) — A claim was refused (owned, sticky, quota, locked, unknown).
• Variables:
  • net.status (string) — Network status
  • net.rtt (number) — Ping (ms)
  • net.peers (number) — Players online

Hooks and modding #

This kit declares no hook and no collection to mod.

Engines #

Declared targets: web, godot, unity, unreal. gripforge kit api net.claim lists the exact settings and services of your version.

Versions #

Kit version 1.2.0.