From e3c21cc87ffaef49afc507117fc0059cb6b1a411 Mon Sep 17 00:00:00 2001 From: Daniel Castellanos Date: Wed, 11 Oct 2023 10:34:19 -0600 Subject: [PATCH] Improving formatting of functions --- docs/functions/abuse-report.md | 4 +++- docs/functions/achievements.md | 16 ++++++++------- docs/functions/application.md | 16 ++++++++------- docs/functions/asset-files.md | 20 ++++++++++--------- docs/functions/attestation-api.md | 3 ++- docs/functions/challenges.md | 18 +++++++++-------- docs/functions/group-presence.md | 30 +++++++++++++++-------------- docs/functions/in-app-purchases.md | 10 ++++++---- docs/functions/initialization.md | 7 ++++--- docs/functions/leaderboards.md | 12 +++++++----- docs/functions/media.md | 3 ++- docs/functions/user-age-category.md | 5 +++-- docs/functions/user.md | 30 +++++++++++++++-------------- 13 files changed, 98 insertions(+), 76 deletions(-) diff --git a/docs/functions/abuse-report.md b/docs/functions/abuse-report.md index 9568d9c..b25e6c0 100644 --- a/docs/functions/abuse-report.md +++ b/docs/functions/abuse-report.md @@ -16,7 +16,9 @@ This signal will be emitted when the user presses the abuse report button. You t //// ------ -## abuse_report_request_handled +## Functions + +### abuse_report_request_handled //// admonition | abuse_report_request_handled(report_request_response : `ReportRequestResponse`) type: abstract diff --git a/docs/functions/achievements.md b/docs/functions/achievements.md index 894b9e6..9b8885f 100644 --- a/docs/functions/achievements.md +++ b/docs/functions/achievements.md @@ -4,7 +4,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-achievements/](https://developer.oculus.com/documentation/native/ps-achievements/) ------ -## achievements_add_count +## Functions + +### achievements_add_count //// admonition | achievements_add_count(achievement_name : `String`, count : `int`) type: abstract @@ -35,7 +37,7 @@ GDOculusPlatform.achievements_add_count("my_count_achievement", 5)\ /// //// -## achievements_add_fields +### achievements_add_fields //// admonition | achievements_add_fields(achievement_name : `String`, fields : `String`) type: abstract @@ -66,7 +68,7 @@ GDOculusPlatform.achievements_add_fields("my_bitfield_achievement", "0011")\ /// //// -## achievements_unlock +### achievements_unlock //// admonition | achievements_unlock(achievement_name : `String`) type: abstract @@ -97,7 +99,7 @@ GDOculusPlatform.achievements_unlock("my_simple_achievement")\ /// //// -## achievements_get_all_definitions +### achievements_get_all_definitions //// admonition | achievements_get_all_definitions() type: abstract @@ -160,7 +162,7 @@ GDOculusPlatform.achievements_get_all_definitions()\ /// //// -## achievements_get_all_progress +### achievements_get_all_progress //// admonition | achievements_get_all_progress() type: abstract @@ -229,7 +231,7 @@ GDOculusPlatform.achievements_get_all_progress()\ /// //// -## achievements_get_definitions_by_name +### achievements_get_definitions_by_name //// admonition | achievements_get_definitions_by_name(achievement_names : `Array`) type: abstract @@ -261,7 +263,7 @@ GDOculusPlatform.achievements_get_definitions_by_name(achievements_n)\ /// //// -## achievements_get_progress_by_name +### achievements_get_progress_by_name //// admonition | achievements_get_progress_by_name(achievement_names : `Array`) type: abstract diff --git a/docs/functions/application.md b/docs/functions/application.md index 3e6ba33..60d9795 100644 --- a/docs/functions/application.md +++ b/docs/functions/application.md @@ -18,7 +18,9 @@ You should call [application_get_launch_details](#application_get_launch_details //// ------ -## application_get_version +## Functions + +### application_get_version //// admonition | application_get_version() type: abstract @@ -56,7 +58,7 @@ GDOculusPlatform.application_get_version()\ /// //// -## application_launch_other_app +### application_launch_other_app //// admonition | application_launch_other_app(app_id : `String`, deeplink_options : `Dictionary`) type: abstract @@ -94,7 +96,7 @@ GDOculusPlatform.application_launch_other_app("50125468232421", deeplink_options /// //// -## application_get_launch_details +### application_get_launch_details //// admonition | application_get_launch_details() type: abstract @@ -156,7 +158,7 @@ if launch_details.launch_type == "DEEPLINK": /// //// -## application_start_app_download +### application_start_app_download //// admonition | application_start_app_download() type: abstract @@ -178,7 +180,7 @@ GDOculusPlatform.application_start_app_download()\ /// //// -## application_check_app_download_progress +### application_check_app_download_progress //// admonition | application_check_app_download_progress() type: abstract @@ -211,7 +213,7 @@ GDOculusPlatform.application_check_app_download_progress()\ /// //// -## application_cancel_app_download +### application_cancel_app_download //// admonition | application_cancel_app_download() type: abstract @@ -233,7 +235,7 @@ GDOculusPlatform.application_cancel_app_download()\ /// //// -## application_install_app_update_and_relaunch +### application_install_app_update_and_relaunch //// admonition | application_install_app_update_and_relaunch(deeplink_options : `Dictionary`) type: abstract diff --git a/docs/functions/asset-files.md b/docs/functions/asset-files.md index 4919ba0..510d5ab 100644 --- a/docs/functions/asset-files.md +++ b/docs/functions/asset-files.md @@ -30,7 +30,9 @@ This signal will be emitted once the asset file has finished downloading. It wil //// ------ -## assetfile_get_list +## Functions + +### assetfile_get_list //// admonition | assetfile_get_list() type: abstract @@ -113,7 +115,7 @@ GDOculusPlatform.assetfile_get_list()\ /// //// -## assetfile_status_by_id +### assetfile_status_by_id //// admonition | assetfile_status_by_id(asset_id : `String`) type: abstract @@ -140,7 +142,7 @@ GDOculusPlatform.assetfile_status_by_id("151548188744")\ /// //// -## assetfile_status_by_name +### assetfile_status_by_name //// admonition | assetfile_status_by_name(asset_name : `String`) type: abstract @@ -165,7 +167,7 @@ GDOculusPlatform.assetfile_status_by_name("my_asset_file.po")\ /// //// -## assetfile_download_by_id +### assetfile_download_by_id //// admonition | assetfile_download_by_id(asset_id : `String`) type: abstract @@ -211,7 +213,7 @@ func call_me_when_finished(asset_file_id : String): /// //// -## assetfile_download_by_name +### assetfile_download_by_name //// admonition | assetfile_download_by_name(asset_name : `String`) type: abstract @@ -240,7 +242,7 @@ func call_me_when_finished(asset_file_id : String): /// //// -## assetfile_download_cancel_by_id +### assetfile_download_cancel_by_id //// admonition | assetfile_download_cancel_by_id(asset_id : `String`) type: abstract @@ -280,7 +282,7 @@ GDOculusPlatform.assetfile_download_cancel_by_id("244752684352")\ /// //// -## assetfile_download_cancel_by_name +### assetfile_download_cancel_by_name //// admonition | assetfile_download_cancel_by_name(asset_name : `String`) type: abstract @@ -306,7 +308,7 @@ GDOculusPlatform.assetfile_download_cancel_by_name("my_asset_name.zip")\ /// //// -## assetfile_delete_by_id +### assetfile_delete_by_id //// admonition | assetfile_delete_by_id(asset_id : `String`) type: abstract @@ -346,7 +348,7 @@ GDOculusPlatform.assetfile_delete_by_id("774568224174")\ /// //// -## assetfile_delete_by_name +### assetfile_delete_by_name //// admonition | assetfile_delete_by_name(asset_name : `String`) type: abstract diff --git a/docs/functions/attestation-api.md b/docs/functions/attestation-api.md index 752409f..dddfa72 100644 --- a/docs/functions/attestation-api.md +++ b/docs/functions/attestation-api.md @@ -4,8 +4,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-attestation-api/](https://developer.oculus.com/documentation/native/ps-attestation-api/) ------ +## Functions -## deviceappintegrity_get_integrity_token +### deviceappintegrity_get_integrity_token //// admonition | deviceappintegrity_get_integrity_token(challenge_nonce : `String`) type: abstract diff --git a/docs/functions/challenges.md b/docs/functions/challenges.md index 3477231..9fb14b1 100644 --- a/docs/functions/challenges.md +++ b/docs/functions/challenges.md @@ -4,7 +4,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-challenges/](https://developer.oculus.com/documentation/native/ps-challenges/) ------ -## challenges_get +## Functions + +### challenges_get //// admonition | challenges_get(challenge_id : `String`) type: abstract @@ -85,7 +87,7 @@ GDOculusPlatform.challenges_get("511854451440")\ /// //// -## challenges_get_list +### challenges_get_list //// admonition | challenges_get_list(limit : `int`, challenge_options : `Dictionary`) type: abstract @@ -234,7 +236,7 @@ GDOculusPlatform.challenges_get_list(10, challenge_filters)\ /// //// -## challenges_get_entries +### challenges_get_entries //// admonition | challenges_get_entries(challenge_id : `String`, limit : `int`, filter : `LeaderboardFilterType`, start_at : `LeaderboardStartAt`) type: abstract @@ -316,7 +318,7 @@ leaderboard_info.start_at\ /// //// -## challenge_get_entries_after_rank +### challenge_get_entries_after_rank //// admonition | challenge_get_entries_after_rank(challenge_id : `String`, limit : `int`, after_rank : `int`) type: abstract @@ -368,7 +370,7 @@ challenge_info.after_rank\ /// //// -## challenge_get_entries_by_ids +### challenge_get_entries_by_ids //// admonition | challenge_get_entries_by_ids(challenge_id : `String`, limit : `int`, user_ids : `Array`, start_at : `LeaderboardStartAt`) type: abstract @@ -416,7 +418,7 @@ challenge_info.start_at\ /// //// -## challenges_join +### challenges_join //// admonition | challenges_join(challenge_id : `String`) type: abstract @@ -440,7 +442,7 @@ GDOculusPlatform.challenges_join("264822651547")\ /// //// -## challenges_leave +### challenges_leave //// admonition | challenges_leave(challenge_id : `String`) type: abstract @@ -464,7 +466,7 @@ GDOculusPlatform.challenges_leave("264822651547")\ /// //// -## challenges_decline_invite +### challenges_decline_invite //// admonition | challenges_decline_invite(challenge_id : `String`) type: abstract diff --git a/docs/functions/group-presence.md b/docs/functions/group-presence.md index eac4448..10501a8 100644 --- a/docs/functions/group-presence.md +++ b/docs/functions/group-presence.md @@ -5,7 +5,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-multiplayer-overview](https://developer.oculus.com/documentation/native/ps-multiplayer-overview) ------ -## grouppresence_clear +## Functions + +### grouppresence_clear //// admonition | grouppresence_clear() type: abstract @@ -27,7 +29,7 @@ GDOculusPlatform.grouppresence_clear()\ /// //// -## grouppresence_send_invites +### grouppresence_send_invites //// admonition | grouppresence_send_invites(user_ids : `Array`) type: abstract @@ -101,7 +103,7 @@ GDOculusPlatform.grouppresence_send_invites(user_ids)\ /// //// -## grouppresence_set +### grouppresence_set //// admonition | grouppresence_set(options : `Dictionary`) type: abstract @@ -140,7 +142,7 @@ GDOculusPlatform.grouppresence_set(presence_opts)\ /// //// -## grouppresence_set_deeplink_message_override +### grouppresence_set_deeplink_message_override //// admonition | grouppresence_set_deeplink_message_override(deeplink_message : `String`) type: abstract @@ -162,7 +164,7 @@ GDOculusPlatform.grouppresence_set_deeplink_message_override("SOME_OVERRIDE_DL") /// //// -## grouppresence_set_destination +### grouppresence_set_destination //// admonition | grouppresence_set_destination(destination : `String`) type: abstract @@ -184,7 +186,7 @@ GDOculusPlatform.grouppresence_set_destination("MISTY_FOREST")\ /// //// -## grouppresence_set_is_joinable +### grouppresence_set_is_joinable //// admonition | grouppresence_set_destination(is_joinable : `bool`) type: abstract @@ -206,7 +208,7 @@ GDOculusPlatform.grouppresence_set_is_joinable(false)\ /// //// -## grouppresence_set_lobby_session +### grouppresence_set_lobby_session //// admonition | grouppresence_set_lobby_session(id : `String`) type: abstract @@ -228,7 +230,7 @@ GDOculusPlatform.grouppresence_set_lobby_session("354141101")\ /// //// -## grouppresence_set_match_session +### grouppresence_set_match_session //// admonition | grouppresence_set_match_session(id : `String`) type: abstract @@ -250,7 +252,7 @@ GDOculusPlatform.grouppresence_set_match_session("my_match_651475")\ /// //// -## grouppresence_get_invitable_users +### grouppresence_get_invitable_users //// admonition | grouppresence_get_invitable_users(options : `Dictionary`) type: abstract @@ -288,7 +290,7 @@ GDOculusPlatform.grouppresence_get_invitable_users()\ /// //// -## grouppresence_get_sent_invites +### grouppresence_get_sent_invites //// admonition | grouppresence_get_sent_invites() type: abstract @@ -322,7 +324,7 @@ GDOculusPlatform.grouppresence_get_sent_invites()\ /// //// -## grouppresence_launch_invite_panel +### grouppresence_launch_invite_panel //// admonition | grouppresence_launch_invite_panel(options : `Dictionary`) type: abstract @@ -357,7 +359,7 @@ GDOculusPlatform.grouppresence_launch_invite_panel(options)\ /// //// -## grouppresence_launch_multiplayer_error_dialog +### grouppresence_launch_multiplayer_error_dialog //// admonition | grouppresence_launch_multiplayer_error_dialog(error_key : `MultiplayerErrorErrorKey`) type: abstract @@ -397,7 +399,7 @@ GDOculusPlatform.grouppresence_launch_multiplayer_error_dialog(GDOculusPlatform. /// //// -## grouppresence_launch_rejoin_dialog +### grouppresence_launch_rejoin_dialog //// admonition | grouppresence_launch_rejoin_dialog(lobby_session_id : `String`, match_session_id : `String`, destination_api_name : `String`) type: abstract @@ -420,7 +422,7 @@ GDOculusPlatform.grouppresence_launch_rejoin_dialog("8458441_my_lobby", "", "DES /// //// -## grouppresence_launch_roster_panel +### grouppresence_launch_roster_panel //// admonition | grouppresence_launch_roster_panel(options : `Dictionary`) type: abstract diff --git a/docs/functions/in-app-purchases.md b/docs/functions/in-app-purchases.md index 738bafe..655836c 100644 --- a/docs/functions/in-app-purchases.md +++ b/docs/functions/in-app-purchases.md @@ -4,7 +4,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-iap/](https://developer.oculus.com/documentation/native/ps-iap/) ------ -## iap_get_viewer_purchases +## Functions + +### iap_get_viewer_purchases //// admonition | iap_get_viewer_purchases() type: abstract @@ -55,7 +57,7 @@ GDOculusPlatform.iap_get_viewer_purchases()\ /// //// -## iap_get_products_by_sku +### iap_get_products_by_sku //// admonition | iap_get_products_by_sku(sku_list : `Array`) type: abstract @@ -108,7 +110,7 @@ GDOculusPlatform.iap_get_products_by_sku(sku_list)\ /// //// -## iap_consume_purchase +### iap_consume_purchase //// admonition | iap_consume_purchase(sku : `String`) type: abstract @@ -130,7 +132,7 @@ GDOculusPlatform.iap_consume_purchase("my_product_sku")\ /// //// -## iap_launch_checkout_flow +### iap_launch_checkout_flow //// admonition | iap_launch_checkout_flow(sku : `String`) type: abstract diff --git a/docs/functions/initialization.md b/docs/functions/initialization.md index bce6298..4d4c1c6 100644 --- a/docs/functions/initialization.md +++ b/docs/functions/initialization.md @@ -1,8 +1,9 @@ # Functions - Initialization ----- +## Functions -## is_platform_initialized +### is_platform_initialized //// admonition | is_platform_initialized() type: abstract @@ -21,7 +22,7 @@ if not GDOculusPlatform.is_platform_initialized(): /// //// -## initialize_android +### initialize_android //// admonition | initialize_android(app_id : `String`, options : `Dictionary`) type: abstract @@ -49,7 +50,7 @@ var platform_initialized : bool = GDOculusPlatform.initialize_android("314159265 /// //// -## initialize_android_async +### initialize_android_async //// admonition | initialize_android_async(app_id : `String`) type: abstract diff --git a/docs/functions/leaderboards.md b/docs/functions/leaderboards.md index 6b54104..43c2615 100644 --- a/docs/functions/leaderboards.md +++ b/docs/functions/leaderboards.md @@ -4,7 +4,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-leaderboards/](https://developer.oculus.com/documentation/native/ps-leaderboards/) ------ -## leaderboard_get +## Functions + +### leaderboard_get //// admonition | leaderboard_get(leaderboard_name : `String`) type: abstract @@ -34,7 +36,7 @@ GDOculusPlatform.leaderboard_get("MY_LEADERBOARD_0")\ /// //// -## leaderboard_get_entries +### leaderboard_get_entries //// admonition | leaderboard_get_entries(leaderboard_name : `String`, limit : `int`, filter : `LeaderboardFilterType`, start_at : `LeaderboardStartAt`) type: abstract @@ -146,7 +148,7 @@ leaderboard_info.start_at\ /// //// -## leaderboard_get_entries_after_rank +### leaderboard_get_entries_after_rank //// admonition | leaderboard_get_entries_after_rank(leaderboard_name : `String`, limit : `int`, after_rank : `int`) type: abstract @@ -198,7 +200,7 @@ leaderboard_info.after_rank\ /// //// -## leaderboard_get_entries_by_ids +### leaderboard_get_entries_by_ids //// admonition | leaderboard_get_entries_by_ids(leaderboard_name : `String`, limit : `int`, user_ids : `Array`, start_at : `LeaderboardStartAt`) type: abstract @@ -248,7 +250,7 @@ leaderboard_info.start_at\ /// //// -## leaderboard_write_entry +### leaderboard_write_entry //// admonition | leaderboard_write_entry(leaderboard_name : `String`, score : `int`, force_update : `bool`, extra : `Dictionary`) type: abstract diff --git a/docs/functions/media.md b/docs/functions/media.md index 935b455..ae8ddfa 100644 --- a/docs/functions/media.md +++ b/docs/functions/media.md @@ -1,8 +1,9 @@ # Functions - Media ------ +## Functions -## media_share_to_facebook +### media_share_to_facebook //// admonition | media_share_to_facebook(post_text_suggestion : `String`, file_path : `String`, content_type : `MediaContentType`) type: abstract diff --git a/docs/functions/user-age-category.md b/docs/functions/user-age-category.md index bb03093..c183404 100644 --- a/docs/functions/user-age-category.md +++ b/docs/functions/user-age-category.md @@ -4,8 +4,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-age-group-apis/](https://developer.oculus.com/documentation/native/ps-age-group-apis/) ------ +## Functions -## useragecategory_get +### useragecategory_get //// admonition | useragecategory_get() type: abstract @@ -46,7 +47,7 @@ GDOculusPlatform.useragecategory_get()\ /// //// -## useragecategory_report +### useragecategory_report //// admonition | useragecategory_report(app_age_category : `AppAgeCategory`) type: abstract diff --git a/docs/functions/user.md b/docs/functions/user.md index d87fa5b..31512ad 100644 --- a/docs/functions/user.md +++ b/docs/functions/user.md @@ -6,7 +6,9 @@ Related Oculus Platform documentation: - [https://developer.oculus.com/documentation/native/ps-blockingsdk/](https://developer.oculus.com/documentation/native/ps-blockingsdk/) ------ -## user_get_logged_in_user_id +## Functions + +### user_get_logged_in_user_id //// admonition | user_get_logged_in_user_id() type: abstract @@ -23,7 +25,7 @@ var user_id : String = user_get_logged_in_user_id() /// //// -## user_get_logged_in_user_locale +### user_get_logged_in_user_locale //// admonition | user_get_logged_in_user_locale() type: abstract @@ -40,7 +42,7 @@ var user_locale : String = user_get_logged_in_user_locale() /// //// -## user_get_is_viewer_entitled +### user_get_is_viewer_entitled //// admonition | user_get_is_viewer_entitled() type: abstract @@ -62,7 +64,7 @@ GDOculusPlatform.user_get_is_viewer_entitled()\ /// //// -## user_get_user +### user_get_user //// admonition | user_get_user(user_id : `String`) type: abstract @@ -102,7 +104,7 @@ GDOculusPlatform.user_get_user("31415926535")\ /// //// -## user_get_logged_in_user +### user_get_logged_in_user //// admonition | user_get_logged_in_user() type: abstract @@ -147,7 +149,7 @@ GDOculusPlatform.user_get_logged_in_user()\ /// //// -## user_get_user_proof +### user_get_user_proof //// admonition | user_get_user_proof() type: abstract @@ -175,7 +177,7 @@ GDOculusPlatform.user_get_user_proof()\ /// //// -## user_get_user_access_token +### user_get_user_access_token //// admonition | user_get_user_access_token() type: abstract @@ -197,7 +199,7 @@ GDOculusPlatform.user_get_user_access_token()\ /// //// -## user_get_blocked_users +### user_get_blocked_users //// admonition | user_get_blocked_users() type: abstract @@ -250,7 +252,7 @@ GDOculusPlatform.user_get_blocked_users()\ /// //// -## user_get_logged_in_user_friends +### user_get_logged_in_user_friends //// admonition | user_get_logged_in_user_friends() type: abstract @@ -280,7 +282,7 @@ GDOculusPlatform.user_get_logged_in_user_friends()\ /// //// -## user_get_org_scoped_id +### user_get_org_scoped_id //// admonition | user_get_org_scoped_id(user_id : `String`) type: abstract @@ -302,7 +304,7 @@ GDOculusPlatform.user_get_org_scoped_id("31415926535")\ /// //// -## user_get_sdk_accounts +### user_get_sdk_accounts //// admonition | user_get_sdk_accounts() type: abstract @@ -336,7 +338,7 @@ GDOculusPlatform.user_get_sdk_accounts()\ /// //// -## user_launch_block_flow +### user_launch_block_flow //// admonition | user_launch_block_flow(user_id : `String`) type: abstract @@ -369,7 +371,7 @@ GDOculusPlatform.user_launch_block_flow("89793238462")\ /// //// -## user_launch_unblock_flow +### user_launch_unblock_flow //// admonition | user_launch_unblock_flow(user_id : `String`) type: abstract @@ -402,7 +404,7 @@ GDOculusPlatform.user_launch_unblock_flow("89793238462")\ /// //// -## user_launch_friend_request_flow +### user_launch_friend_request_flow //// admonition | user_launch_friend_request_flow(user_id : `String`) type: abstract