ParentNumber (Daemon property): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
m (match syntax table to syntax template, tags and edits) |
||
| Line 1: | Line 1: | ||
{{Template:Daemon:ParentNumber subtitle}} | {{Template:Daemon:ParentNumber subtitle}} | ||
<var>ParentNumber</var> returns the user number of the parent thread, the thread that created the thread from which this method is being invoked. | |||
If the thread issuing the <var>ParentNumber</var> method is not an <var>sdaemon</var>, or is an <var>sdaemon</var> but not working for a <var>[[Daemon class|Daemon]]</var> object or a <var>$COMMxx</var> function, the <var>ParentNumber</var> property returns a value of <code>-1</code>. | |||
If the thread issuing the ParentNumber method is not an sdaemon, or is an sdaemon but not working for a Daemon object or a $COMMxx function, the ParentNumber property returns a value of < | |||
==Syntax== | ==Syntax== | ||
| Line 13: | Line 8: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>% | <tr><th>%number</th> | ||
<td>A numeric variable to contain the value of the number of the parent thread. </td></tr> | <td>A numeric variable to contain the value of the number of the parent thread.</td></tr> | ||
<tr><th>%(Daemon)</th> | <tr><th>%(Daemon)</th> | ||
<td>The class name in parentheses denotes a shared method. <var>ParentNumber</var> can also be invoked via a <var>Daemon</var> object variable, which may be null.</td></tr> | <td>The class name in parentheses denotes a shared method. <var>ParentNumber</var> can also be invoked via a <var>Daemon</var> object variable, which may be null.</td></tr> | ||
| Line 20: | Line 15: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul><li><var>[[MasterNumber (Daemon property)|MasterNumber]]</var> returns the same value as the <var>ParentNumber</var> method if the parent thread has no parent. Otherwise, <var>MasterNumber</var> method follows the parent chain to the highest level, that is, to the parent that does not have a parent. | ||
<li>An asynchronous $COMMBG daemon or an independent daemon start with the <var>[[RunIndependently (Daemon subroutine)|RunIndependently]]</var> method might have a parent thread but never a master thread; master implies control. | |||
<li><var>ParentNumber</var> has a $function equivalent: <var>[[$DaemonParentNumber|$daemonParentNumber]]</var>. The $function and method can be used interchangeably, whether the daemons were created with $COMMxx functions or Daemon objects. That is, the method can also be used with daemons that were created via $COMMxx, and the $function can also be used with daemons that were created via Daemon objects. | |||
<li><var>ParentNumber</var> is available as of <var class="product">[[Sirius Mods|"Sirius Mods"]]</var> Version 6.8. | |||
</ul> | |||
==Examples== | |||
<ol> | |||
<li>The following code audits a thread's parent user number: | <li>The following code audits a thread's parent user number: | ||
<p class="code">audit 'My parent''s user number is ' %(daemon):parentNumber | <p class="code">audit 'My parent''s user number is ' %(daemon):parentNumber | ||
</p> | </p> | ||
<li>In the following example, a daemon runs a request that creates another daemon. <var>ParentNumber</var> issued on the first daemon thread, returns the user number of the thread that created the first daemon: the user that runs the request. | |||
<li> | <p class="code">begin | ||
%speed is object daemon | |||
%list is object stringList | |||
%s is object stringList | |||
%speed = new | |||
%n is float | |||
In the following example, a daemon runs a request that creates another daemon. | %n = %speed:usernumber | ||
print '1st daemon user number is: ' %n | |||
<p class="code"> | |||
%speed is object daemon | |||
%list is object stringList | |||
% | |||
%speed = new | |||
%n is float | |||
%n = %speed:usernumber | |||
%list = new | %list = new | ||
text to %list | text to %list | ||
begin | |||
%n1 is float | %n1 is float | ||
%n2 is float | %n2 is float | ||
%n3 is float | %n3 is float | ||
%speed2 is object daemon | %speed2 is object daemon | ||
%speed2 = new | %speed2 = new | ||
%n1 = %speed2:usernumber | %n1 = %speed2:usernumber | ||
%n2 = %(Daemon):masternumber | %n2 = %(Daemon):masternumber | ||
%n3 = %(Daemon):parentnumber | %n3 = %(Daemon):parentnumber | ||
print %n1 | print %n1 | ||
print %n2 | print %n2 | ||
print %n3 | print %n3 | ||
end | end | ||
end text | end text | ||
% | %x = new | ||
% | %x = %speed:run(%list) | ||
print '2nd daemon usernum, 1st daemon master and parent are: ' | |||
% | %x:print | ||
end | end | ||
</p> | </p> | ||
The example result follows: | The example result follows: | ||
<p class="code">1st daemon user number is: 3 | <p class="code">1st daemon user number is: 3 | ||
2nd daemon user num, 1st daemon master and parent are: | 2nd daemon user num, 1st daemon master and parent are: | ||
| Line 73: | Line 65: | ||
18 | 18 | ||
18 | 18 | ||
</p> | </p></ol> | ||
==See also== | ==See also== | ||
<ul> | <ul> | ||
<li> | <li><var>[[UserNumber (Daemon property)|UserNumber]]</var> returns the user number of the thread associated with the daemon method object. | ||
</ul> | </ul> | ||
{{Template:Daemon:ParentNumber footer}} | |||
Revision as of 02:36, 14 March 2011
User number of the parent thread (Daemon class)
ParentNumber returns the user number of the parent thread, the thread that created the thread from which this method is being invoked.
If the thread issuing the ParentNumber method is not an sdaemon, or is an sdaemon but not working for a Daemon object or a $COMMxx function, the ParentNumber property returns a value of -1.
Syntax
%number = %(Daemon):ParentNumber
Syntax terms
| %number | A numeric variable to contain the value of the number of the parent thread. |
|---|---|
| %(Daemon) | The class name in parentheses denotes a shared method. ParentNumber can also be invoked via a Daemon object variable, which may be null. |
Usage notes
- MasterNumber returns the same value as the ParentNumber method if the parent thread has no parent. Otherwise, MasterNumber method follows the parent chain to the highest level, that is, to the parent that does not have a parent.
- An asynchronous $COMMBG daemon or an independent daemon start with the RunIndependently method might have a parent thread but never a master thread; master implies control.
- ParentNumber has a $function equivalent: $daemonParentNumber. The $function and method can be used interchangeably, whether the daemons were created with $COMMxx functions or Daemon objects. That is, the method can also be used with daemons that were created via $COMMxx, and the $function can also be used with daemons that were created via Daemon objects.
- ParentNumber is available as of "Sirius Mods" Version 6.8.
Examples
- The following code audits a thread's parent user number:
audit 'My parents user number is ' %(daemon):parentNumber
- In the following example, a daemon runs a request that creates another daemon. ParentNumber issued on the first daemon thread, returns the user number of the thread that created the first daemon: the user that runs the request.
begin %speed is object daemon %list is object stringList %s is object stringList %speed = new %n is float %n = %speed:usernumber print '1st daemon user number is: ' %n %list = new text to %list begin %n1 is float %n2 is float %n3 is float %speed2 is object daemon %speed2 = new %n1 = %speed2:usernumber %n2 = %(Daemon):masternumber %n3 = %(Daemon):parentnumber print %n1 print %n2 print %n3 end end text %x = new %x = %speed:run(%list) print '2nd daemon usernum, 1st daemon master and parent are: ' %x:print end
The example result follows:
1st daemon user number is: 3 2nd daemon user num, 1st daemon master and parent are: 5 18 18
See also
- UserNumber returns the user number of the thread associated with the daemon method object.