Docs for the new methods.

This commit is contained in:
Relintai 2025-05-11 18:42:47 +02:00
parent 066e88e336
commit 704cea8354
2 changed files with 17 additions and 3 deletions

View File

@ -125,6 +125,12 @@
Returns the stored [UserModule] that has it's name set as the name parameter.
</description>
</method>
<method name="get_owner_user_manager">
<return type="UserManager" />
<description>
Returns the owner [UserManager]. (The one that this User was created by.)
</description>
</method>
<method name="hash_password">
<return type="String" />
<argument index="0" name="password" type="String" />
@ -167,6 +173,14 @@
Notifies the active [UserManager] that this User needs to be saved.
</description>
</method>
<method name="set_owner_user_manager">
<return type="void" />
<argument index="0" name="user_manager" type="Node" />
<description>
Sets the owner [UserManager].
Only use this in [method UserManager._create_user] or if you know what you are doing.
</description>
</method>
<method name="to_dict">
<return type="Dictionary" />
<description>

View File

@ -20,7 +20,7 @@
The [code]user[/code] parameter allows for setting up classes that inherit from [User].
This is the method where [UserModule]s that the application always expects to be present should be set up.
Example:
[code]func _create_user(user: User) -> User:
[code]func _create_user(user: User) -&gt; User:
if !user:
user = InheritedUser.new()