Experiments

server

This API is used to retrieve relevant experiment group information for players in your experience.

local Gamebeast = require(game:GetService("ReplicatedStorage"):WaitForChild("Gamebeast"))
local GamebeastExperiments = Gamebeast:GetService("Experiments") :: Gamebeast.ExperimentsService

Types

ExperimentGroupMetadata

type ExperimentGroupMetadata = {
    experimentName: string, -- The name of the experiment this group belongs to.
    groupName: string, -- The name of the group this player is in.
}

:GetGroupForPlayer(player)

→ ExperimentGroupMetadata?

This method retrieves the experiment group metadata for a specific player. If the player is not in any experiment group, this method will return nil.

player

Player

The player to get the group for.

Usage

local groupMetaData = GamebeastExperiments:GetGroupForPlayer(player)
 
if groupMetaData then
    print("Player is in group", groupMetaData.groupName, "of experiment", groupMetaData.experimentName)
else
    print("Player is not in any experiment group.")
end

Configs Jobs