Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-02-02 22:35:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Re-extracted class docs.

Browse Source
This commit is contained in:
Relintai 2023-12-23 00:54:40 +01:00
parent 094b1fe752
commit db08e3c8b9
2 changed files with 52 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/classes/Thread.xml
View File

@ -39,7 +39,7 @@
<argument index="3" name="priority" type="int" enum="Thread.Priority" default="1" />
<description>
Starts a new [Thread] that runs [code]method[/code] on object [code]instance[/code] with [code]userdata[/code] passed as an argument. Even if no userdata is passed, [code]method[/code] must accept one argument and it will be null. The [code]priority[/code] of the [Thread] can be changed by passing a value from the [enum Priority] enum.
Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure.
Returns [constant OK] on success, or [constant ERR_CANT_CREATE] on failure.
</description>
</method>
<method name="wait_to_finish">

51
modules/web/doc_classes/SMTPClient.xml Normal file
View File

@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="SMTPClient" inherits="Node" version="4.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="send_mail">
<return type="void" />
<argument index="0" name="address" type="String" />
<argument index="1" name="subject" type="String" />
<argument index="2" name="message" type="String" />
<description>
</description>
</method>
</methods>
<members>
<member name="auth_type" type="int" setter="set_auth_type" getter="get_auth_type" enum="SMTPClient.AuthType" default="2">
</member>
<member name="get_delay" type="int" setter="set_delay" getter="get_delay" default="200">
</member>
<member name="retries" type="int" setter="set_retries" getter="get_retries" default="3">
</member>
<member name="smtp_client_id" type="String" setter="set_smtp_client_id" getter="get_smtp_client_id" default="&quot;&quot;">
</member>
<member name="smtp_server_address" type="String" setter="set_smtp_server_address" getter="get_smtp_server_address" default="&quot;&quot;">
</member>
<member name="smtp_server_password" type="String" setter="set_smtp_server_password" getter="get_smtp_server_password" default="&quot;&quot;">
</member>
<member name="smtp_server_port" type="int" setter="set_smtp_server_port" getter="get_smtp_server_port" default="465">
</member>
<member name="smtp_server_sender_email_address" type="String" setter="set_smtp_server_sender_email_address" getter="get_smtp_server_sender_email_address" default="&quot;&quot;">
</member>
<member name="smtp_server_sender_name" type="String" setter="set_smtp_server_sender_name" getter="get_smtp_server_sender_name" default="&quot;&quot;">
</member>
<member name="smtp_server_user_name" type="String" setter="set_smtp_server_user_name" getter="get_smtp_server_user_name" default="&quot;&quot;">
</member>
<member name="use_threads" type="bool" setter="set_use_threads" getter="get_use_threads" default="true">
</member>
</members>
<constants>
<constant name="AUTH_TYPE_PLAINTEXT" value="0" enum="AuthType">
</constant>
<constant name="AUTH_TYPE_STARTTLS" value="1" enum="AuthType">
</constant>
<constant name="AUTH_TYPE_SMTPS" value="2" enum="AuthType">
</constant>
</constants>
</class>