Docs for the new methods.

This commit is contained in:
Relintai 2025-05-11 20:00:02 +02:00
parent 5266b791d5
commit aa6ed3911f

View File

@ -105,6 +105,12 @@
Uses [method from_dict] internally. Uses [method from_dict] internally.
</description> </description>
</method> </method>
<method name="get_email_internal" qualifiers="const">
<return type="String" />
<description>
Returns a cached internal simplified version of the email. Use it as keys, and lookups.
</description>
</method>
<method name="get_module"> <method name="get_module">
<return type="UserModule" /> <return type="UserModule" />
<argument index="0" name="index" type="int" /> <argument index="0" name="index" type="int" />
@ -131,6 +137,12 @@
Returns the owner [UserManager]. (The one that this User was created by.) Returns the owner [UserManager]. (The one that this User was created by.)
</description> </description>
</method> </method>
<method name="get_user_name_internal" qualifiers="const">
<return type="String" />
<description>
Returns a cached internal simplified version of the user_name. Use it as keys, and lookups.
</description>
</method>
<method name="hash_password"> <method name="hash_password">
<return type="String" /> <return type="String" />
<argument index="0" name="password" type="String" /> <argument index="0" name="password" type="String" />
@ -181,6 +193,14 @@
Only use this in [method UserManager._create_user] or if you know what you are doing. Only use this in [method UserManager._create_user] or if you know what you are doing.
</description> </description>
</method> </method>
<method name="string_to_internal_format" qualifiers="const">
<return type="String" />
<argument index="0" name="str" type="String" />
<description>
Turns a [String] into an internal simplified lowercase format.
[method get_email_internal] and [method get_user_name_internal] uses the output from this.
</description>
</method>
<method name="to_dict"> <method name="to_dict">
<return type="Dictionary" /> <return type="Dictionary" />
<description> <description>