Function Reference #

1

nk.account_delete_id("8f4d52c7-bf28-4fcf-8af2-1d4fcf685592", false)

1
2

local user_id = "4ec4f126-3f9d-11e7-84ef-b7c182b36521"
local account_data = nk.account_export_id(user_id)

1
2
3

local account = nk.account_get_id("8f4d52c7-bf28-4fcf-8af2-1d4fcf685592")
local wallet = account.wallet
nk.logger_info(string.format("Wallet is: %s", nk.json_encode(wallet)))

1
2

local user_ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}
local accounts = nk.accounts_get_id(user_ids)

1
2
3
4
5
6
7
8
9

local user_id = "4ec4f126-3f9d-11e7-84ef-b7c182b36521" -- Some user ID.
local metadata = {}
local username = ""
local display_name = nil
local timezone = nil
local location = nil
local language = nil
local avatar_url = nil
nk.account_update_id(user_id, metadata, username, display_name, timezone, location, language, avatar_url)

1

local user_id, username, created = nk.authenticate_apple("some-oauth-access-token", "username", true)

1

local user_id, username, created = nk.authenticate_custom("48656C6C6F20776F726C64", "username", true)

1

local user_id, username, created = nk.authenticate_device("48656C6C6F20776F726C64", "username", true)

1

local user_id, username, created = nk.authenticate_email("email@example.com", "48656C6C6F20776F726C64", "username", true)

1

local user_id, username, created = nk.authenticate_facebook("some-oauth-access-token", true, "username", true)

1

local user_id, username, created = nk.authenticate_facebook_instant_game("player-info", true, "username", true)

1

local user_id, username, created = nk.authenticate_game_center(player_id, bundle_id, timestamp, salt, signature, public_key_url, username, create)

1

local user_id, username, created = nk.authenticate_google("some-id-token", "username", true)

1

local user_id, username, created = nk.authenticate_steam("steam-token", "username", true)

1
2

local token, exp = nk.authenticate_token_generate("user_id", "username")
nk.logger_info(("Access token: %q, valid for %q seconds"):format(token, exp))

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.link_apple(user_id, "some-oauth-access-token")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.link_custom(user_id, "48656C6C6F20776F726C64")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.link_device(user_id, "22226C6C6F20776F726C22")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.link_email(user_id, "email@example.com", "password")

1
2
3

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
local import_friends = true
nk.link_facebook(user_id, "username", "some-oauth-access-token", import_friends)

1
2
3

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
local import_friends = true
nk.link_facebook_instant_game(user_id, "player-info", import_friends)

1
2
3

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
local timestamp = 1
nk.link_gamecenter(user_id, "player_id", "bundle_id", timestamp, "salt", "signature", "public_key_url")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.link_google(user_id, "some-oauth_access_token")

1
2
3

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
local import_friends = true
nk.link_steam(user_id, "username", "some-oauth_access_token", import_friends)

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_apple(user_id, "some-oauth-access-token")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_custom(user_id, "48656C6C6F20776F726C64")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_device(user_id, "22226C6C6F20776F726C22")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_email(user_id, "email@example.com")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_facebook(user_id, "username", "some-oauth-access-token")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_facebook_instant_game(user_id, "player-info")

1
2
3

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
local timestamp = 1
nk.unlink_gamecenter(user_id, "player_id", "bundle_id", timestamp, "salt", "signature", "public_key_url")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_google(user_id, "some-oauth_access_token")

1
2

local user_id = "87fc43cf-16f1-4852-8fd3-12c07caccf7e"
nk.unlink_steam(user_id, "some-oauth_access_token")

1
2
3
4

-- Channel Id Build
local sender_id = "SenderId"
local target = "RoomName"
local channel_type = 1

1
2
3

-- Channel Message Remove
local remove_ack = nk.channel_message_remove("<ChannelId>", "<MessageId>", "<SenderId>", "<SenderUsername>", true)
nk.logger_info("%q deleted at %q", remove_ack.messageId, remove_ack.createTime)

1
2
3
4
5

local content = {}
content["message"] = "hello"

local create_ack = nk.channel_message_send("<ChannelId>", content, "<SenderId>", "<SenderUsername>", true)
nk.logger_info("%q created at %q", create_ack.messageId, create_ack.createTime)

1
2

-- Channel Messages List
local channel_id = "<ChannelId>"

1
2
3
4
5

local content = {}
content["message"] = "hello"

local update_ack = nk.channel_message_update("<ChannelId>", "<MessageId>", content, "<SenderId>", "<SenderUsername>", true)
nk.logger_info("%q created at %q", update_ack.messageId, update_ack.createTime)

1
2
3
4
5

local properties = { some = "property" }
local timestamp = 0
local external = false

nk.event(name, properties, timestamp, external)

1
2
3
4
5
6

local user_id = "b1aafe16-7540-11e7-9738-13777fcc7cd8"
local username = "username"
local ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}
local usernames = {"newfriend1", "newfriend2"}

local friends = nk.friends_add(user_id, username, ids, usernames)

1
2
3
4
5
6

local user_id = "b1aafe16-7540-11e7-9738-13777fcc7cd8"
local username = "username"
local ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}
local usernames = {"blockedfriend1", "blockedfriend2"}

local friends = nk.friends_block(user_id, username, ids, usernames)

1
2
3
4
5
6

local user_id = "b1aafe16-7540-11e7-9738-13777fcc7cd8"
local username = "username"
local ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}
local usernames = {"exfriend1", "exfriend2"}

local friends = nk.friends_delete(user_id, username, ids, usernames)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

local user_id = "b1aafe16-7540-11e7-9738-13777fcc7cd8"
local limit = 100
local state = nil
local cursor = nil

local friends = nk.friends_list(user_id, limit, state, cursor)

for _, m in ipairs(friends) do
  -- States are: friend(0), invite_sent(1), invite_received(2), blocked(3)
  local msg = string.format("Friend username %q has state %q", m.user.username, m.state)
  nk.logger_info(msg)
end

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

local metadata = { -- Add whatever custom fields you want.
  my_custom_field = "some value"
}

local user_id = "dcb891ea-a311-4681-9213-6741351c9994"
local creator_id = "dcb891ea-a311-4681-9213-6741351c9994"
local name = "Some unique group name"
local description = "My awesome group."
local lang = "en"
local open = true
local creator_id = "4c2ae592-b2a7-445e-98ec-697694478b1c"
local avatar_url = "url://somelink"
local maxMemberCount = 100

nk.group_create(user_id, name, creator_id, lang, description, avatar_url, open, metadata, maxMemberCount)

1
2

local group_id = "f00fa79a-750f-11e7-8626-0fb79f45ff97"
nk.group_delete(group_id)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

local group_ids = {
  "0BF154F1-F7D1-4AAA-A060-5FFED3CDB982",
  "997C0D18-0B25-4AEC-8331-9255BD36665D"
}

local groups = nk.groups_get_id(group_ids)

for _, g in ipairs(groups) do
  local msg = string.format("Group name %q with id %q", g.name, g.id)
  nk.logger_info(msg)
end

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

local group_name = "Heroic"
local lang_tag = "en"
local members = 10
local open = true
local limit = 100

local groups = nk.groups_list(group_name, lang_tag, members, open, limit)

for i, group in ipairs(groups) do
  nk.logger_info(string.format("ID: %q - can enter? %q", group.id, group.can_enter))
end

1
2
3
4
5
6
7
8

local metadata = {
  some_field = "some value"
}

group_id = "f00fa79a-750f-11e7-8626-0fb79f45ff97"
description = "An updated description."

nk.group_update(group_id, nil, "", "", "", description, "", nil, metadata, 0)

1
2
3
4
5

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local user_id = "9a51cf3a-2377-11eb-b713-e7d403afe081"
local username = "myusername"

nk.group_user_join(group_id, user_id, username)

1
2
3
4
5

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local user_id = "9a51cf3a-2377-11eb-b713-e7d403afe081"
local username = "myusername"

nk.group_user_leave(group_id, user_id, username)

1
2
3
4

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local user_ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}

nk.group_users_add(group_id, user_ids)

1
2
3
4

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local user_ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}

nk.group_users_ban(group_id, user_ids)

1
2
3
4

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local user_ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}

nk.group_users_demote(group_id, user_ids)

1
2
3
4

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local user_ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}

nk.group_users_kick(group_id, user_ids)

1
2
3
4
5
6
7

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local members = nk.group_users_list(group_id)

for _, m in ipairs(members) do
  local msg = string.format("Member username %q has state %q", m.user.username, m.state)
  nk.logger_info(msg)
end

1
2
3
4

local group_id = "a1aafe16-7540-11e7-9738-13777fcc7cd8"
local user_ids = {"9a51cf3a-2377-11eb-b713-e7d403afe081", "a042c19c-2377-11eb-b7c1-cfafae11cfbc"}

nk.group_users_promote(group_id, user_ids)

1
2
3
4
5
6
7

local user_id = "64ef6cb0-7512-11e7-9e52-d7789d80b70b"
local groups = nk.user_groups_list(user_id)

for _, g in ipairs(groups) do
  local msg = string.format("User has state %q in group %q", g.state, g.group.name)
  nk.logger_info(msg)
end

1
2
3
4
5

local function my_func(ctx, leaderboard, reset)
  -- Custom logic
end

nk.register_leaderboard_reset(my_func)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

local function matchmaker_matched(context, matched_users)
  for _, m in ipairs(matched_users) do
    nk.logger_info(m.presence["user_id"])
    nk.logger_info(m.presence["session_id"])
    nk.logger_info(m.presence["username"])
    nk.logger_info(m.presence["node"])

    for _, p in ipairs(m.properties) do
      nk.logger_info(p)
    end
  end

  if #matched_users ~= 2 then
    return nil
  end

  if matched_users[1].properties["mode"] ~= "authoritative" then
    return nil
  end

  if matched_users[2].properties["mode"] ~= "authoritative" then
    return nil
  end

  return nk.match_create("match", { debug = true, expected_users = matched_users })
end

nk.register_matchmaker_matched(matchmaker_matched)

1
2
3
4
5

local function my_func(context, payload)
  -- Run some code.
end

nk.register_req_after(my_func, "FriendsAdd")

1
2
3
4
5
6

local function my_func(context, payload)
  -- Run some code.
  return payload -- Important!
end

nk.register_req_before(my_func, "FriendsAdd")

1
2
3
4
5
6

local function my_func(context, payload)
  -- Run some code.
  return payload
end

nk.register_rpc(my_func, "my_func_id")

1
2
3
4
5

local function my_func(context, payload)
  -- Run some code.
end

nk.register_rt_after(my_func, "ChannelJoin")

1
2
3
4
5
6

local function my_func(context, payload)
  -- Run some code.
  return payload -- Important!
end

nk.register_rt_before(my_func, "ChannelJoin")

1
2
3
4
5

local function my_func(ctx, leaderboard, reset)
  -- Custom logic
end

nk.register_tournament_end(my_func)

1
2
3
4
5

local function my_func(ctx, leaderboard, reset)
  -- Custom logic
end

nk.register_tournament_reset(my_func)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

local function insert_user(context)
  -- This is to create a system ID that cannot be used via a client.
  local system_id = context.env["SYSTEM_ID"]

  nk.sql_exec([[
    INSERT INTO users (id, username)
    VALUES ($1, $2)
    ON CONFLICT (id) DO NOTHING
  ]], { system_id, "system_id" })
end

nk.run_once(insert_user)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

local id = "4ec4f126-3f9d-11e7-84ef-b7c182b36521"
local authoritative = false
local sort = "desc"
local operator = "best"
local reset = "0 0 * * 1"

local metadata = {
  weather_conditions = "rain"
}

nk.leaderboard_create(id, authoritative, sort, operator, reset, metadata)

1
2

local id = "4ec4f126-3f9d-11e7-84ef-b7c182b36521"
nk.leaderboard_delete(id)

1
2
3
4
5
6
7

local limit = 100  -- Number to list per page.

local leaderboards = nk.leaderboard_list(limit)

for i, leaderboard in ipairs(leaderboards) do
  nk.logger_info(string.format("ID: %q - can enter? %q", leaderboard.id, leaderboard.can_enter))
end

1
2
3
4

local id = "4ec4f126-3f9d-11e7-84ef-b7c182b36521"
local owner = "4c2ae592-b2a7-445e-98ec-697694478b1c"

nk.leaderboard_record_delete(id, owner)

1
2
3
4

local id = "4ec4f126-3f9d-11e7-84ef-b7c182b36521"
local owner = "4c2ae592-b2a7-445e-98ec-697694478b1c"

nk.leaderboard_records_haystack(id, owner, 10)

1
2
3
4
5
6
7

local id = "4ec4f126-3f9d-11e7-84ef-b7c182b36521"
local owners = {}
local limit = 10
local cursor = ""
local override_expiry = 3600

local records, owner_records, next_cursor, prev_cursor = nk.leaderboard_records_list(id, owners, limit, cursor, override_expiry)