API Functions

Listed here are all API functions, along with instructions on how to use them.

When an argument is bold, it is required.

Open Door

Info

API.Doors.Open:Fire(Door)

Opens the CheckMeIn door specified.

Arguments Door Type: Door Model

Example

API.Doors.Open:Fire(workspace.CheckMeIn.Doors.Rooms['My Cool Room'])

Checked In

Info

API.Service.CheckedIn.Event:Connect(function(Employee, Player, Door)

This event fires when a user is checked in.

• This event fires when the employee who sent a check in request leaves the game before it is accepted. In this case, the employee property will be set to nil.

• This event fires when self check in is used. The employee property will be set to 'SCI' (string).

Return Values Employee Type: Variable (Player, string or nil) Player Type: Player Door Type: Door Model

Example

API.Service.CheckedIn.Event:Connect(function(Employee, Player, Door)
    if Employee then
        if type(Employee) == 'string' then
        -- You have now discovered the Player used Self Check In
        else
        -- You have now discovered Employee exists.
        end
    end
end)

Checked Out

Info

API.Service.CheckedOut.Event:Connect(function(Employee, Player, Door)

This event fires when a user is checked out.

• This event fires when players disconnect. The employee property will be set to 'DISCONNECT' (string).

• This event fires when the employee who sent a check out request leaves the game before it is accepted. In this case, the employee property will be set to nil.

• This event fires when self check out is used. The employee property will be set to 'SCI' (string).

Return Values Employee Type: Variable (Player, string or nil) Player Type: Player Door Type: Door Model

Example

API.Service.CheckedOut.Event:Connect(function(Employee, Player, Door)
    print(Player.Name .. ' was checked out.')
end)

Force Check In

Info

API.Service.ForceCheckIn:Fire(Player, RoomType)

Forcefully checks specified player into specified RoomType. Ignores game pass requirements.

When no room is available, this function will do nothing.

Arguments Player Type: Player RoomType Type: String (must be a valid room type, case sensitive)

Example

See the Tutorial section for more advanced examples.

Roblox Premium Rooms

API.Service.ForceCheckIn:Fire(game.Players.wind_o,'Premium Suite')

Force Check Out

Info

API.Service.ForceCheckOut:Fire(Player)

Forcefully checks out specified player.

If Player is not checked in, this function will do nothing.

Arguments Player Type: Player

Example

API.Service.ForceCheckOut:Fire(game.Players.wind_o)

ExceededLimit

Info

API.Service.ExceededLimit.Event:Connect(function(Player)

This event fires when Player is spamming remote events. Exact configuration of the Cooldown system can be found here.

You should read the Cooldown Service tutorial before using this function.

Return Values Player Type: Player

Get Points

Info

API.Web.GetPoints:Invoke(userId)

Returns Points value of specified player.

Arguments userId Type: UserId Return Values Points Type: Integer (amount of points player has)

Example

if API.Web.GetPoints:Invoke(game.Players.wind_o.UserId) > 100 then
    print('wind_o is rich!')
end

Reward Points

Info

API.Web.RewardPoints:Fire(userId, amount)

Awards points to specified player.

• When no amount is specified, the function will reward the normal amount of points, set in the Configuration module. This value can be found at Workspace.CheckMeIn.Configuration.Points.Reward

• The target player must be online in the server for this function to work.

Arguments userId Type: UserId amount Type: Integer

Example

API.Web.RewardPoints:Fire(game.Players.wind_o.UserId, 1337)

Set Points

Info

API.Web.SetPoints:Fire(userId, amount)

Sets the Points value of the specified player.

SetPoints will overwrite any existing data. Please be careful with this command.

• The target player must be online in the server for this function to work.

Arguments userId Type: UserId amount Type: Integer

Example

--Wind_o's been mean. He needs his points reset.
API.Web.SetPoints:Fire(game.Players.wind_o.UserId, 0)

Get Tutorial State

Info

API.Web.GetTutorialState(Player)

Gets tutorial state (whether the CheckMeIn tutorial was completed) for the specified Player.

Arguments Player Type: Player Return Values TutorialState Type: Boolean

Example

game.Players.PlayerAdded:Connect(function(Player)
    local TutorialState = API.Web.GetTutorialState:Invoke(Player)
    
    if not TutorialState then
    --CheckMeIn Tutorial not completed, perhaps show them the ropes
    --of the entire game?
    end
end)

Webhook

Deprecated

Info

API.Web.Webhook:Fire(Message)

Sends Message to your Discord Webhook.

The Discord Webhook in CheckMeIn is deprecated and does not respect rate limits. Do not use this function to prevent your Discord account from being deleted.

Arguments Message Type: String

Example

API.Web.Webhook:Fire('Hello world!')