HELIX 3 Docs
Platform API

Social & Presence

Friends, presence, and invites — the social graph that powers HELIX's virality loop, available identically on every runtime.

Helix.social exposes the player's social graph: who their friends are, who's online, and how to pull them into your world. Because identity is platform-wide, friendships and presence work across every world automatically.

API

Prop

Type

Invite a friend into your world

const friends = await Helix.social.getFriends();
const online = [];
for (const f of friends) {
  const p = await Helix.social.getPresence(f.id);
  if (p.online) online.push(f);
}

// pull an online friend into this instance
if (online[0]) await Helix.social.inviteToInstance(online[0].id);

Presence

Presence tells you whether a friend is online and, when permitted, what world they're in — the basis for "join friend" buttons and for surfacing active sessions. Respect the player's privacy settings; the platform enforces visibility.

Related social surfaces

Real-time chat is Helix.chat; spatial/proximity voice is Helix.voice (see the Add proximity voice guides). Friend discovery can optionally link external accounts (e.g. Discord) through official SDKs — never by scraping.

Reference

On this page