Skip to content

Commit 9016345

Browse files
authored
Merge pull request #6 from devloglogan/docs-update
Add more documentation
2 parents 85b8c58 + 8d3fca9 commit 9016345

14 files changed

+224
-7
lines changed

doc_classes/MetaPlatformSDK.xml

Lines changed: 191 additions & 3 deletions
Large diffs are not rendered by default.

doc_classes/MetaPlatformSDK_AchievementDefinition.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
The name of the achievement.
1717
</member>
1818
<member name="target" type="int" setter="" getter="get_target" default="0">
19+
The target count of the achievement, if the [member type] is [constant MetaPlatformSDK.ACHIEVEMENT_TYPE_COUNT].
1920
</member>
2021
<member name="type" type="int" setter="" getter="get_type" enum="MetaPlatformSDK.AchievementType" default="0">
2122
The type of achievement.

doc_classes/MetaPlatformSDK_AdvancedAbuseReportOptions.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,13 @@
1919
<method name="clear_developer_defined_context">
2020
<return type="void" />
2121
<description>
22+
Clears the custom metadata of the report.
2223
</description>
2324
</method>
2425
<method name="clear_suggested_users">
2526
<return type="void" />
2627
<description>
28+
Clears the list of users to suggest for reporting.
2729
</description>
2830
</method>
2931
<method name="set_developer_defined_context_string">

doc_classes/MetaPlatformSDK_AssetFileDownloadUpdate.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@
1313
ID of the asset file.
1414
</member>
1515
<member name="bytes_total_long" type="int" setter="" getter="get_bytes_total_long" default="0">
16+
Total number of bytes.
1617
</member>
1718
<member name="bytes_transferred_long" type="int" setter="" getter="get_bytes_transferred_long" default="0">
19+
Number of bytes that have been downloaded.
1820
</member>
1921
<member name="completed" type="bool" setter="" getter="get_completed" default="false">
2022
Flag indicating a download is completed.

doc_classes/MetaPlatformSDK_ChallengeEntry.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@
1212
<member name="display_score" type="String" setter="" getter="get_display_score" default="&quot;&quot;">
1313
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.
1414
</member>
15-
<member name="extra_data" type="String" setter="" getter="get_extra_data" default="&quot;&quot;">
15+
<member name="extra_data" type="PackedByteArray" setter="" getter="get_extra_data" default="PackedByteArray()">
1616
A 2KB custom data field that is associated with the challenge entry.
1717
</member>
1818
<member name="extra_data_length" type="int" setter="" getter="get_extra_data_length" default="0">
19+
The length in bytes of [member extra_data].
1920
</member>
2021
<member name="id" type="int" setter="" getter="get_id" default="0">
2122
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].

doc_classes/MetaPlatformSDK_ChallengeOptions.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<class name="MetaPlatformSDK_ChallengeOptions" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
33
<brief_description>
4-
Represents options to a challenge.
4+
Represents challenge search options.
55
</brief_description>
66
<description>
7-
Represents options to a challenge.
7+
Represents challenge search options.
88
</description>
99
<tutorials>
1010
</tutorials>

doc_classes/MetaPlatformSDK_HttpTransferUpdate.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@
2121
An array of bytes that represents the data being transferred.
2222
</member>
2323
<member name="id" type="int" setter="" getter="get_id" default="0">
24+
The ID of the HTTP transfer update.
2425
</member>
2526
<member name="size" type="int" setter="" getter="get_size" default="0">
27+
The number of bytes contained in [member bytes].
2628
</member>
2729
</members>
2830
</class>

doc_classes/MetaPlatformSDK_InviteOptions.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
<method name="clear_suggested_users">
2020
<return type="void" />
2121
<description>
22+
Clears suggested users from the invitable users list.
2223
</description>
2324
</method>
2425
</methods>

doc_classes/MetaPlatformSDK_LeaderboardEntry.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,11 @@
1212
<member name="display_score" type="String" setter="" getter="get_display_score" default="&quot;&quot;">
1313
The formatted score that will be displayed in the leaderboard of this entry. You can select a score type to determine how scores are displayed on Leaderboard. See [url=https://developer.oculus.com/documentation/native/ps-leaderboards/#create]here[/url] for examples of different score type.
1414
</member>
15-
<member name="extra_data" type="String" setter="" getter="get_extra_data" default="&quot;&quot;">
15+
<member name="extra_data" type="PackedByteArray" setter="" getter="get_extra_data" default="PackedByteArray()">
1616
A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer. It will be used by two entry methods: [method MetaPlatformSDK.leaderboard_write_entry_async] and [method MetaPlatformSDK.leaderboard_write_entry_with_supplementary_metric_async].
1717
</member>
1818
<member name="extra_data_length" type="int" setter="" getter="get_extra_data_length" default="0">
19+
The length in bytes of [member extra_data].
1920
</member>
2021
<member name="id" type="int" setter="" getter="get_id" default="0">
2122
This is a unique identifier for the leaderboard entry. It is of type `id` and is optional.

doc_classes/MetaPlatformSDK_LeaderboardUpdateStatus.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
A `boolean` indicates whether the leaderboard was updated.
2323
</member>
2424
<member name="updated_challenge_ids_size" type="int" setter="" getter="get_updated_challenge_ids_size" default="0">
25+
The count of challenge IDs available in [method get_updated_challenge_id].
2526
</member>
2627
</members>
2728
</class>

0 commit comments

Comments
 (0)