Update for v71 of the Platform SDK (#3)

Author: dsnopek

.github/workflows/build-addon-on-push.yml

@@ -13,8 +13,8 @@ env:
   # Only used for the cache key. Increment version to force clean build.
   GODOT_BASE_BRANCH: main
   SCONS_CACHE: ${{ github.workspace }}/.scons-cache/
-  # Meta Platform SDK v67.0.
-  META_PLATFORM_SDK_URL: "https://securecdn.oculus.com/binaries/download/?id=6176126005844383"
+  # Meta Platform SDK v71.0.
+  META_PLATFORM_SDK_URL: "https://securecdn.oculus.com/binaries/download/?id=6945981485525494"
 
 jobs:
   build:

README.md

@@ -15,7 +15,7 @@ git submodule update --init --recursive
 Then download the [Oculus Platform SDK](https://developer.oculus.com/downloads/package/oculus-platform-sdk/) and extract
 it into `thirdparty/ovr_platform_sdk`, such that `thirdparty/ovr_platform_sdk/Include/OVR_Platform.h` exists.
 
-We've tested with v67 of the Platform SDK.
+We've tested with v71 of the Platform SDK.
 
 ### Build the toolkit
 

doc_classes/MetaPlatformSDK.xml

@@ -10,8 +10,10 @@
 	</tutorials>
 	<members>
 		<member name="just_unlocked" type="bool" setter="" getter="get_just_unlocked" default="false">
+			This indicates if this update caused the achievement to unlock.
 		</member>
 		<member name="name" type="String" setter="" getter="get_name" default="&quot;&quot;">
+			The unique name used to reference the updated achievement, as specified in the developer dashboard.
 		</member>
 	</members>
 </class>

doc_classes/MetaPlatformSDK_AchievementUpdate.xml

@@ -13,12 +13,16 @@
 			This may be [code]null[/code], which indicates that the value is not present or that the curent app or user is not permitted to access it.
 		</member>
 		<member name="id" type="int" setter="" getter="get_id" default="0">
+			The ID of the application invite.
 		</member>
 		<member name="is_active" type="bool" setter="" getter="get_is_active" default="false">
+			A boolean value indicating whether the invite is still active or not.
 		</member>
 		<member name="lobby_session_id" type="String" setter="" getter="get_lobby_session_id" default="&quot;&quot;">
+			The lobby session id to which the recipient is invited.
 		</member>
 		<member name="match_session_id" type="String" setter="" getter="get_match_session_id" default="&quot;&quot;">
+			The match session id to which the recipient is invited.
 		</member>
 		<member name="recipient" type="MetaPlatformSDK_User" setter="" getter="get_recipient">
 			This may be [code]null[/code], which indicates that the value is not present or that the curent app or user is not permitted to access it.

doc_classes/MetaPlatformSDK_ApplicationInvite.xml

@@ -16,8 +16,10 @@
 			A displayable string of the challenge's description.
 		</member>
 		<member name="end_date" type="int" setter="" getter="get_end_date" default="0">
+			The timestamp when this challenge ends. You can retrieve this field from the response of the challenge creation request.
 		</member>
 		<member name="id" type="int" setter="" getter="get_id" default="0">
+			The ID of the challenge. This is an unique string that the application will refer to this challenge in your app.
 		</member>
 		<member name="invited_users" type="MetaPlatformSDK_UserArray" setter="" getter="get_invited_users">
 			This may be [code]null[/code], which indicates that the value is not present or that the curent app or user is not permitted to access it.
@@ -29,6 +31,7 @@
 			This may be [code]null[/code], which indicates that the value is not present or that the curent app or user is not permitted to access it.
 		</member>
 		<member name="start_date" type="int" setter="" getter="get_start_date" default="0">
+			The timestamp when this challenge begins. You can retrieve this field from the response of the challenge creation request.
 		</member>
 		<member name="title" type="String" setter="" getter="get_title" default="&quot;&quot;">
 			A displayable string of the challenge's title.

doc_classes/MetaPlatformSDK_Challenge.xml

@@ -10,20 +10,27 @@
 	</tutorials>
 	<members>
 		<member name="display_score" type="String" setter="" getter="get_display_score" default="&quot;&quot;">
+			A displayable score for this challenge entry. The score is formatted with thousands separators and the relevant units are appended based on the associated leaderboard's score type.
 		</member>
 		<member name="extra_data" type="String" setter="" getter="get_extra_data" default="&quot;&quot;">
+			A 2KB custom data field that is associated with the challenge entry.
 		</member>
 		<member name="extra_data_length" type="int" setter="" getter="get_extra_data_length" default="0">
 		</member>
 		<member name="id" type="int" setter="" getter="get_id" default="0">
+			The unique identifier of this challenge entry which can be used by [method MetaPlatformSDK.challenges_get_entries_by_ids_async] and [method MetaPlatformSDK.challenges_get_entries_async].
 		</member>
 		<member name="rank" type="int" setter="" getter="get_rank" default="0">
+			Challenges can be ranked by highest or lowest scores within a time period. This indicates the position of this challenge entry.
 		</member>
 		<member name="score" type="int" setter="" getter="get_score" default="0">
+			The raw underlying value of the challenge entry score. It is a type of string that is returned by a long integer.
 		</member>
 		<member name="timestamp" type="int" setter="" getter="get_timestamp" default="0">
+			The timestamp of the creation of this entry in the challenge.
 		</member>
 		<member name="user" type="MetaPlatformSDK_User" setter="" getter="get_user">
+			The user corresponding to this entry within the challenge.
 		</member>
 	</members>
 </class>

doc_classes/MetaPlatformSDK_ChallengeEntry.xml

@@ -13,30 +13,35 @@
 			<return type="void" />
 			<param index="0" name="value" type="String" />
 			<description>
+				The description of the challenge is a detailed and informative text that provides a comprehensive overview of the challenge's objectives, rules, and requirements.
 			</description>
 		</method>
 		<method name="set_end_date">
 			<return type="void" />
 			<param index="0" name="value" type="int" />
 			<description>
+				The challenge end date is the timestamp when this challenge ends.
 			</description>
 		</method>
 		<method name="set_include_active_challenges">
 			<return type="void" />
 			<param index="0" name="value" type="bool" />
 			<description>
+				This option indicates whether to include challenges that are currently active in the search results. By default, this is set to true, meaning that only active challenges will be returned.
 			</description>
 		</method>
 		<method name="set_include_future_challenges">
 			<return type="void" />
 			<param index="0" name="value" type="bool" />
 			<description>
+				This option indicates whether to include challenges that have not yet started in the search results. By default, this is set to false, meaning that only active will be returned.
 			</description>
 		</method>
 		<method name="set_include_past_challenges">
 			<return type="void" />
 			<param index="0" name="value" type="bool" />
 			<description>
+				This option indicates whether to include challenges that have already ended in the search results. By default, this is set to false, meaning that only active will be returned.
 			</description>
 		</method>
 		<method name="set_leaderboard_name">
@@ -50,24 +55,29 @@
 			<return type="void" />
 			<param index="0" name="value" type="int" />
 			<description>
+				The challenge start date is the timestamp when this challenge begins.
 			</description>
 		</method>
 		<method name="set_title">
 			<return type="void" />
 			<param index="0" name="value" type="String" />
 			<description>
+				The title of the challenge is a descriptive label that provides a concise summary of the challenge's purpose and objectives.
 			</description>
 		</method>
 		<method name="set_viewer_filter">
 			<return type="void" />
 			<param index="0" name="value" type="int" enum="MetaPlatformSDK.ChallengeViewerFilter" />
 			<description>
+				An enum that specifies what filter to apply to the list of returned challenges.
+				Returns all public and invite-only challenges in which the user is a participant or invitee. Excludes private challenges.
 			</description>
 		</method>
 		<method name="set_visibility">
 			<return type="void" />
 			<param index="0" name="value" type="int" enum="MetaPlatformSDK.ChallengeVisibility" />
 			<description>
+				The challenge visibility setting specifies who can see and participate in this challenge.
 			</description>
 		</method>
 	</methods>

doc_classes/MetaPlatformSDK_ChallengeOptions.xml

@@ -13,23 +13,27 @@
 			<return type="int" />
 			<param index="0" name="key" type="String" />
 			<description>
+				It's a method that takes a string key as a parameter and returns a boolean value indicating whether the key exists in the data store.
 			</description>
 		</method>
 		<method name="get_key" qualifiers="const">
 			<return type="String" />
 			<param index="0" name="index" type="int" />
 			<description>
+				It's a string that represents a single key in the data store. It allows you to retrieve a specific key from the data store by its index
 			</description>
 		</method>
 		<method name="get_value" qualifiers="const">
 			<return type="String" />
 			<param index="0" name="key" type="String" />
 			<description>
+				It's a generic field that can hold any type of data. It allows you to store and retrieve data using a string key, and it can be used to store a variety of data types
 			</description>
 		</method>
 	</methods>
 	<members>
 		<member name="num_keys" type="int" setter="" getter="get_num_keys" default="0">
+			It's an integer that represents the number of keys in the data store.
 		</member>
 	</members>
 </class>

doc_classes/MetaPlatformSDK_DataStore.xml

@@ -16,6 +16,7 @@
 			The information that will be in [member MetaPlatformSDK_LaunchDetails.deeplink_message] when a user enters via deeplink. Alternatively will be in [member MetaPlatformSDK_User.presence_deeplink_message] if the rich presence is set for the user.
 		</member>
 		<member name="display_name" type="String" setter="" getter="get_display_name" default="&quot;&quot;">
+			A displayable string of the destination name.
 		</member>
 		<member name="shareable_uri" type="String" setter="" getter="get_shareable_uri" default="&quot;&quot;">
 			A URL that allows the user to deeplink directly to this destination.