getStreamSyncedMeta() #

Used to store cross-resource accessible information. This functionality stores an object on a player that can than be set with setStreamSyncedMeta. This can also be accessed on client-side.

The player on client-side is only updated if they are in streaming range of another player.

This type of meta is accessible anywhere but can only be set on server-side.

Function Definition #

public getStreamSyncedMeta<V extends any>(key: string): V | undefined;

Arguments #

• key: string

Returns #

• V | undefined

Documentation #

Examples #

const data = player.getStreamSyncedMeta('myData');
if (!data) {
    // Does does not exist.
    return;
}

console.log(data);