Profile Selector: Difference between revisions

(8 intermediate revisions by 2 users not shown)

Line 1:

This is the applet presented when launching a game that allows the user to select a user.

See [[AM_services#Library_Applets]]~~. The profile selector expects a two [[AM_services#IStorage|IStorage]] inputs and a single [[AM_services#IStorage|IStorage]] output~~.

See [[AM_services#Library_Applets]].

== Library Applet Versions ==

Line 24:

| 0x0 || 0x4 || [[#UiMode]]

|-

| 0x4 || 0x4 ||

| 0x4 || 0x4 || Padding.

|-

| 0x8 || 0x80 || u128 invalidUidList[8]. This is copied from [[#UserSelectionSettings]].

Line 36:

| 0x92 || 0x1 || Set to 0x1 by ShowUserSelectorForSystem/ShowUserSelectorForLauncher.

|-

| 0x93 || 0x1 || u8 isPermitted. ShowUserSelector* sets this to the output bool from [[Account_services#IsUserRegistrationRequestPermitted|IsUserRegistrationRequestPermitted]].

| 0x93 || 0x1 || u8 isPermitted. ShowUserSelector* sets this to the output bool from [[Account_services#IsUserRegistrationRequestPermitted|IsUserRegistrationRequestPermitted]]. With [[#UiMode|UserSelector]] this enables the option to create a new user. When not set, a dialog will be displayed when the user attempts to create an user.

|-

| 0x94 || 0x1 || u8 showSkipButton. This is copied from [[#UserSelectionSettings]].

Line 87:

|-

| 12 || [7.0.0+] UserCreatorForImmediateNaLoginTest

|-

| 13 || [13.0.0+] UserQualificationPromoter

|}

Line 100:

Line 102:

| 0x80 || 0x1 || u8 isSkipEnabled

|-

| 0x81 || 0x1 || u8 isNetworkServiceAccountRequired

| 0x81 || 0x1 || u8 isNetworkServiceAccountRequired. Whether the user needs to be linked to a Nintendo account.

|-

| 0x82 || 0x1 || u8 showSkipButton

| 0x82 || 0x1 || u8 showSkipButton. Enables the option to skip user selection with a button.

|-

| 0x83 || 0x1 || u8 additionalSelect

Line 108:

Line 110:

| 0x84 || 0x1 || [6.0.0+] u8 isUnqualifiedUserSelectable

|}

ShowUserSelector* calls ShowUserSelectorCommon for launching the applet, which does the following:

* When isSkipEnabled is set, the first user in invalidUidList must not be set, and additionalSelect must be 0 (asserting otherwise). When enabled [[Account_services#TrySelectUserWithoutInteraction|TrySelectUserWithoutInteraction]] will be used to select the user (with isNetworkServiceAccountRequired), in this case the applet will only be launched if that cmd doesn't return an user.

== UserSelectionSettingsForSystemService ==

Line 116:

Line 121:

! Offset || Size || Description

|-

| 0x0 || 0x4 ||

| 0x0 || 0x4 || [[#UserSelectionPurpose]]

|-

| 0x4 || 0x1 ||

| 0x4 || 0x1 || Enables the user-creation button when set. Whether user-creation when pressing the button is actually allowed is controlled by [[#UiSettings]] isPermitted.

|-

| 0x5 || 0x3 || u8 padding[3]

Line 124:

Line 129:

== UiReturnArg ==

This is "nn::account::UiReturnArg".

This is "nn::account::UiReturnArg". This is the struct for the output storage.

{| class="wikitable" border="1"

Line 130:

Line 135:

! Offset || Size || Description

|-

| 0x0 || 0x8 || Result ~~(0 = Success, 2 = Failure)~~

| 0x0 || 0x8 || Result. Returned directly as the Result when launching is successful.

|-

| 0x8 || 0x10 || ~~UUID~~ of selected user

| 0x8 || 0x10 || Uid of selected user, only used with [[#UiMode|UserSelector]] when no error is thrown (see above Result).

|}

Line 142:

Line 147:

! Value || Description

|-

| 0 ||

| 0 || LoginAndCreate

|-

| 1 || Login

|-

| 2 || Create

|}

== UserSelectionPurpose ==

This is "nn::account::UserSelectionPurpose". This controls the UI message text to display with [[#UiMode|UserSelector]]. Invalid values are handled as value 0.

{| class="wikitable" border="1"

|-

! Value || Description || UI message text

|-

| 0 || General || "Select a user."

|-

| 1 || [2.0.0+] GameCardRegistration || "Who will receive the points?"

|-

| 2 || [2.0.0+] EShopLaunch || "Who is using Nintendo eShop?"

|-

| 3 || [2.0.0+] EShopItemShow || "Who is making this purchase?"

|-

| 4 || [2.0.0+] PicturePost || "Who is posting?"

|-

| 5 || [2.0.0+] NintendoAccountLinkage || "Select a user to link to a Nintendo Account."

|-

| 6 || [2.0.0+] SettingsUpdate || "Change settings for which user?"

|-

| 7 || [2.0.0+] SaveDataDeletion || "Format data for which user?"

|-

| 1 ||

| 8 || [4.0.0+] UserMigration || "Which user will be transferred to another console?"

|-

| 2 ||

| 9 || [8.0.0+] SaveDataTransfer(?) || "Send save data for which user?"

|}

== Usage ==

User-processes should push a common arguments struct and the ~~typical UserSelectionConfig struct as well~~. After ~~pushing in~~ the ~~data~~ and ~~calling start~~, ~~user-processes~~ should ~~wait upon the PopOutDataEvent and then pop a single IStorage to obtain the result structure described above~~.

User-processes should push a common arguments struct and [[#UiSettings]]. Official sw can optionally push an additional storage from [[Applet_Manager_services#CreateTransferMemoryStorage|CreateTransferMemoryStorage]] with flag=0 using an input buffer when that input buffer is not NULL, however sdknso itself doesn't use this besides a wrapper func which sdknso itself doesn't call (the applet itself ignores this storage, at least with [9.1.0+]). After launching the applet and waiting for it to finish, on success the output storage [[#UiReturnArg]] should be popped.

[[Category:Library Applets]]

@@ Line 1: / Line 1: @@
 This is the applet presented when launching a game that allows the user to select a user.
-See [[AM_services#Library_Applets]]. The profile selector expects a two [[AM_services#IStorage|IStorage]] inputs and a single [[AM_services#IStorage|IStorage]] output.
+See [[AM_services#Library_Applets]].
 == Library Applet Versions ==
@@ Line 24: / Line 24: @@
 | 0x0 || 0x4 || [[#UiMode]]
 |-
-| 0x4 || 0x4 ||
+| 0x4 || 0x4 || Padding.
 |-
 | 0x8 || 0x80 || u128 invalidUidList[8]. This is copied from [[#UserSelectionSettings]].
@@ Line 36: / Line 36: @@
 | 0x92 || 0x1 || Set to 0x1 by ShowUserSelectorForSystem/ShowUserSelectorForLauncher.
 |-
-| 0x93 || 0x1 || u8 isPermitted. ShowUserSelector* sets this to the output bool from [[Account_services#IsUserRegistrationRequestPermitted|IsUserRegistrationRequestPermitted]].
+| 0x93 || 0x1 || u8 isPermitted. ShowUserSelector* sets this to the output bool from [[Account_services#IsUserRegistrationRequestPermitted|IsUserRegistrationRequestPermitted]]. With [[#UiMode|UserSelector]] this enables the option to create a new user. When not set, a dialog will be displayed when the user attempts to create an user.
 |-
 | 0x94 || 0x1 || u8 showSkipButton. This is copied from [[#UserSelectionSettings]].
@@ Line 87: / Line 87: @@
 |-
 | 12 || [7.0.0+] UserCreatorForImmediateNaLoginTest
+|-
+| 13 || [13.0.0+] UserQualificationPromoter
 |}
@@ Line 100: / Line 102: @@
 | 0x80 || 0x1 || u8 isSkipEnabled
 |-
-| 0x81 || 0x1 || u8 isNetworkServiceAccountRequired
+| 0x81 || 0x1 || u8 isNetworkServiceAccountRequired. Whether the user needs to be linked to a Nintendo account.
 |-
-| 0x82 || 0x1 || u8 showSkipButton
+| 0x82 || 0x1 || u8 showSkipButton. Enables the option to skip user selection with a button.
 |-
 | 0x83 || 0x1 || u8 additionalSelect
@@ Line 108: / Line 110: @@
 | 0x84 || 0x1 || [6.0.0+] u8 isUnqualifiedUserSelectable
 |}
+ShowUserSelector* calls ShowUserSelectorCommon for launching the applet, which does the following:
+* When isSkipEnabled is set, the first user in invalidUidList must not be set, and additionalSelect must be 0 (asserting otherwise). When enabled [[Account_services#TrySelectUserWithoutInteraction|TrySelectUserWithoutInteraction]] will be used to select the user (with isNetworkServiceAccountRequired), in this case the applet will only be launched if that cmd doesn't return an user.
 == UserSelectionSettingsForSystemService ==
@@ Line 116: / Line 121: @@
 ! Offset || Size || Description
 |-
-| 0x0 || 0x4 ||
+| 0x0 || 0x4 || [[#UserSelectionPurpose]]
 |-
-| 0x4 || 0x1 ||
+| 0x4 || 0x1 || Enables the user-creation button when set. Whether user-creation when pressing the button is actually allowed is controlled by [[#UiSettings]] isPermitted.
 |-
 | 0x5 || 0x3 || u8 padding[3]
@@ Line 124: / Line 129: @@
 == UiReturnArg ==
-This is "nn::account::UiReturnArg".
+This is "nn::account::UiReturnArg". This is the struct for the output storage.
 {| class="wikitable" border="1"
@@ Line 130: / Line 135: @@
 ! Offset || Size || Description
 |-
-| 0x0 || 0x8 || Result (0 = Success, 2 = Failure)
+| 0x0 || 0x8 || Result. Returned directly as the Result when launching is successful.
 |-
-| 0x8 || 0x10 || UUID of selected user
+| 0x8 || 0x10 || Uid of selected user, only used with [[#UiMode|UserSelector]] when no error is thrown (see above Result).
 |}
@@ Line 142: / Line 147: @@
 ! Value || Description
 |-
-| 0 ||
+| 0 || LoginAndCreate
+|-
+| 1 || Login
+|-
+| 2 || Create
+|}
+== UserSelectionPurpose ==
+This is "nn::account::UserSelectionPurpose". This controls the UI message text to display with [[#UiMode|UserSelector]]. Invalid values are handled as value 0.
+{| class="wikitable" border="1"
+|-
+! Value || Description || UI message text
+|-
+| 0 || General || "Select a user."
+|-
+| 1 || [2.0.0+] GameCardRegistration || "Who will receive the points?"
+|-
+| 2 || [2.0.0+] EShopLaunch || "Who is using Nintendo eShop?"
+|-
+| 3 || [2.0.0+] EShopItemShow || "Who is making this purchase?"
+|-
+| 4 || [2.0.0+] PicturePost || "Who is posting?"
+|-
+| 5 || [2.0.0+] NintendoAccountLinkage || "Select a user to link to a Nintendo Account."
+|-
+| 6 || [2.0.0+] SettingsUpdate || "Change settings for which user?"
+|-
+| 7 || [2.0.0+] SaveDataDeletion || "Format data for which user?"
 |-
-| 1 ||
+| 8 || [4.0.0+] UserMigration || "Which user will be transferred to another console?"
 |-
-| 2 ||
+| 9 || [8.0.0+] SaveDataTransfer(?) || "Send save data for which user?"
 |}
 == Usage ==
-User-processes should push a common arguments struct and the typical UserSelectionConfig struct as well. After pushing in the data and calling start, user-processes should wait upon the PopOutDataEvent and then pop a single IStorage to obtain the result structure described above.
+User-processes should push a common arguments struct and [[#UiSettings]]. Official sw can optionally push an additional storage from [[Applet_Manager_services#CreateTransferMemoryStorage|CreateTransferMemoryStorage]] with flag=0 using an input buffer when that input buffer is not NULL, however sdknso itself doesn't use this besides a wrapper func which sdknso itself doesn't call (the applet itself ignores this storage, at least with [9.1.0+]). After launching the applet and waiting for it to finish, on success the output storage [[#UiReturnArg]] should be popped.
 [[Category:Library Applets]]