Exports

Reference for server and client exports provided by the bridge. Use these from other resources to trigger cooldowns, manage allowlists, manage groups, and use the prop placer.

Cooldowns (server)

Export	Parameters	Description
`startGlobalCooldown`	`(cooldownKey: string, minutes: number)`	Starts a global cooldown for the given duration.
`startCooldownByIdentifier`	`(identifier: string, cooldownKey: string, minutes: number, startCooldownByIdentifier?: boolean)`	Starts a cooldown for an identifier.
`startCooldownByPlayerId`	`(playerId: number, cooldownKey: string, minutes: number, applyToAllCharacters?: boolean)`	Starts a cooldown for a player.
`isCooldownActive`	`(cooldownKey: string)`	Returns `boolean` whether the cooldown is active.
`isCooldownActiveForIdentifier`	`(identifier: string, cooldownKey: string)`	Returns `boolean` whether the cooldown is active for that identifier.

Allowlist

Client

Export	Parameters	Returns	Description
`IsAllowlisted`	`(allowlist: string)`	`boolean`	Whether the current character has the allowlist.

Server

Export	Parameters	Returns	Description
`GetAllowlist`	`(stateId: string)`	`table<string, boolean>`	All allowlists for the character.
`HasAllowlist`	`(stateId: string, allowlist: string)`	`boolean`	Whether the character has the allowlist.
`AddAllowlist`	`(source: number, stateId: string, allowlist: string)`	`boolean`	Adds the allowlist; returns success.
`RemoveAllowlist`	`(source: number, stateId: string, allowlist: string)`	`boolean`	Removes the allowlist; returns success.

Groups (server)

Export	Parameters	Returns	Description
`CreateGroup`	`(leaderSrc: number)`	`table<{ success, error?, group? }>`	Creates a group with the player as leader.
`GetGroupFromMember`	`(src: number)`	`Group?`	Group the player is in, if any.
`GetGroupFromMemberByIdentifier`	`(identifier: string)`	`Group?`	Group for that identifier, if any.
`GetGroupByUuid`	`(uuid: string)`	`Group?`	Group with the given UUID.
`GetGroupByPartyUuid`	`(uuid: string)`	`Group?`	Group with the given party UUID.
`GetGroupIdFromMember`	`(src: number)`	`string?`	Group UUID for the player, if in a group.
`GetGroupIdFromMemberByIdentifier`	`(identifier: string)`	`string?`	Group UUID for that identifier, if in a group.
`GetGroupPlayerIds`	`(uuid: string)`	`number[]`	All player IDs in the group.

Group type

The Group type and related structures are described in Types.

Prop placer (client)

Export	Parameters	Returns	Description
`PropPlacer`	`(model: number, forceGround?: boolean, allowedMaterials?: table, maxDistance?: number)`	`vector4 \| null`	Opens the prop placer; returns position and heading or `null` if cancelled.