Skip to content

Functions - Achievements

Related Oculus Platform documentation:

Functions

achievements_add_count

achievements_add_count(achievement_name : String, count : int)

Adds count to the achievement with the given name. The achievement must be of type COUNT.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the achievement's state if fulfilled. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
{
    "name": "my_count_achievement",
    "just_unlocked": false
}

Example 
1
2
3
4
5
6
7
8
GDOculusPlatform.achievements_add_count("my_count_achievement", 5)\
.then(func(add_count_resp : Dictionary):
    if add_count_resp.just_unlocked:
        print("Achievement unlocked!")
)\
.error(func(add_count_err):
    print("Unable to update achievement: ", add_count_err)
)

achievements_add_fields

achievements_add_fields(achievement_name : String, fields : String)

Unlocks fields of an achievement of type BITFIELD. The fields argument must be a String containing either "0" or "1" characters. Every "1" will unlock the field in the corresponding position. For example, if the bitfield is 10011 and you call this function with fields = 00110, the result will be 10111.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the achievement's state if fulfilled. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
{
    "name": "my_bitfield_achievement",
    "just_unlocked": true
}

Example 
1
2
3
4
5
6
7
8
GDOculusPlatform.achievements_add_fields("my_bitfield_achievement", "0011")\
.then(func(add_fields_resp : Dictionary):
    if add_fields_resp.just_unlocked:
        print("Achievement unlocked!")
)\
.error(func(add_fields_err):
    print("Unable to update achievement: ", add_fields_err)
)

achievements_unlock

achievements_unlock(achievement_name : String)

Unlocks the achievement with the given achievement_name. The achievement can be of any type.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with information about the achievement's state if fulfilled. The promise will error if the request couldn't be completed.

Example response: 

1
2
3
4
{
    "name": "my_simple_achievement",
    "just_unlocked": true
}

Example 
1
2
3
4
5
6
7
8
GDOculusPlatform.achievements_unlock("my_simple_achievement")\
.then(func(unlock_achievement_resp : Dictionary):
    if unlock_achievement_resp.just_unlocked:
        print("Achievement unlocked!")
)\
.error(func(unlock_achievement_err):
    print("Unable to update achievement: ", unlock_achievement_err)
)

achievements_get_all_definitions

achievements_get_all_definitions()

Requests all achievement definitions of this app.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with two keys: data and next_page_url. Data will contain information about all the achievements if fulfilled. The promise will error if the request couldn't be completed.

Example response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "data": [
        {
            "name": "my_achievement",
            "bitfield_length": 0,
            "target": 0,
            "type": "SIMPLE"
        },
        {
            "name": "my_count_achievement",
            "bitfield_length": 0,
            "target": 64,
            "type": "COUNT"
        },
        {
            "name": "my_bitfield_achievement",
            "bitfield_length": 8,
            "target": 5,
            "type": "BITFIELD"
        }
    ],
    "next_page_url": ""
}

More info about next_page_url.

Note

type can be SIMPLE, COUNT or BITFIELD.

Example 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
GDOculusPlatform.achievements_get_all_definitions()\
.then(func(achievs : Dictionary):
    if not achievs.next_page_url.is_empty():
        # Get next page
        pass

    for achievement in achievs.data:
        print("Achievement: ", achievement.name)
)\
.error(func(achievements_err):
    print("Unable to get achievement definitions: ", achievements_err)
)

achievements_get_all_progress

achievements_get_all_progress()

Requests all the progress of the achievements of this app.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with two keys: data and next_page_url. The data key will contain information about the user's progress in all the achievements if fulfilled. The promise will error if the request couldn't be completed.

Example response:

 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
{
    "data": [
        {
            "name": "my_achievement",
            "current_count": 0,
            "current_bitfield": "",
            "is_unlocked": true,
            "unlock_time": 1683990416
        },
        {
            "name": "my_count_achievement",
            "current_count": 12,
            "current_bitfield": "",
            "is_unlocked": false,
            "unlock_time": 0
        },
        {
            "name": "my_bitfield_achievement",
            "current_count": 0,
            "current_bitfield": "10011",
            "is_unlocked": false,
            "unlock_time": 0
        }
    ],
    "next_page_url": ""
}

More info about next_page_url.

Note

unlock_time is a UNIX timestamp (in seconds).

The response only includes achievements where the user is "participating", meaning that if for example you have an achievement of type COUNT and the user has not made progress towards this achievement yet, it will not be included (instead of just showing 0).

Example 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
GDOculusPlatform.achievements_get_all_progress()\
.then(func(achievements_prog : Dictionary):
    if not achievements_prog.next_page_url.is_empty():
        # Get next page
        pass

    for achievement_progress in achievements_prog.data:
        print("Achievement name: ", achievement_progress.name)
        print("Unlocked? ", achievement_progress.is_unlocked)
)\
.error(func(achievements_progress_err):
    print("Unable to get achievements progress: ", achievements_progress_err)
)

achievements_get_definitions_by_name

achievements_get_definitions_by_name(achievement_names : Array)

Requests achievement definitions by name of this app. The achievement_names argument must contain Strings only.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with two keys: data and get_next_url. The data key will contain information about the achievements requested if fulfilled. The promise will error if the request couldn't be completed.

Note

Take a look at the example response and the note from the achievements_get_all_definitions function to know more details about the possible response from this function.

Example 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var achievements_n : Array = ["my_achievement", "my_bitfield_achievement"]

GDOculusPlatform.achievements_get_definitions_by_name(achievements_n)\
.then(func(achievement_defs : Dictionary):

    for achievement_def in achievement_defs.data:
        print("Achievement name: ", achievement_def.name)
)\
.error(func(achievement_defs_err):
    print("Unable to get achievement definitions by name: ", achievement_defs_err)
)

achievements_get_progress_by_name

achievements_get_progress_by_name(achievement_names : Array)

Requests progress information of achievements by their name. The achievement_names argument must contain Strings only.

Returns: A GDOculusPlatformPromise that will contain a Dictionary with two keys: data and next_page_url. The data key will contain information about progress of the achievements requested if fulfilled. The promise will error if the request couldn't be completed.

Note

Take a look at the example response and the note from the achievements_get_all_definitions function to know more details about the possible response from this function.

Example 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
var achievements : Array = ["my_count_achievement"]

GDOculusPlatform.achievements_get_progress_by_name(achievements)\
.then(func(achievements_prog : Dictionary):

    if not achievements_prog.next_page_url.is_empty():
        # Get next page
        pass

    for achievement_progress in achievements_prog.data:
        print("Achievement name: ", achievement_progress.name)
        print("Unlock_time: ", achievement_progress.unlock_time)
)\
.error(func(achievements_progress_err):
    print("Unable to get achievements progress: ", achievements_progress_err)
)