This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 13:29, 4 May 2007 (edit) Sandman (Talk | contribs) m ← Previous diff		Revision as of 01:26, 31 October 2007 (edit) (undo) Sandman (Talk | contribs) m Next diff →
Line 15:		Line 15:
	== Returns ==		== Returns ==
-	'''INT''' : Successrate	+	'''INT''' :
	{|		{|
-	| [[false]] || - There was an error.	+	| [[false]] || - The specified processID<nowiki>|</nowiki>processTypeID was 0 or a [[processTypeID]].
	|-		|-
-	| [[true]] || - Sending was successful.	+	| [[true]] || - The specified processID<nowiki>|</nowiki>processTypeID was a [[processID]].
	|}		|}
	== Errors ==		== Errors ==
	{|		{|
-	| Invalid signal || - The specified signal is invalid.	+	| Invalid processID || - The [[process]] with specified processID is not alive. ''(Pre [[0.90.2]] only)''
		+	|-
		+	| Invalid signal || - The specified [[signals|signal]] is invalid.
	|}		|}

---

Revision as of 01:26, 31 October 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Errors 5 Notes 6 Example

Definition

INT Signal ( <INT processID|processTypeID> , <INT signal> )

Allows a process or a range of processes of certain processType to be controlled in a limited number of ways, by sending signals.

Parameters

INT processID|processTypeID	- The ProcessID of the process or the ProcessTypeID of the type of processes to which the signal is to be sent.
INT signal	- The code of the signal that is to be sent to the target process.

Returns

INT :

false	- The specified processID|processTypeID was 0 or a processTypeID.
true	- The specified processID|processTypeID was a processID.

Errors

Invalid processID	- The process with specified processID is not alive. (Pre 0.90.2 only)
Invalid signal	- The specified signal is invalid.

Notes

To obtain the processType of a function, the operator Type can be used. For a process to send a signal to itself, the local variable id can be used. The parameter signal is passed by way of a set of signals which denote the signal which is to be sent.

Example

Signal( get_id(type enemy) , s_kill ); // Kills a process of type enemy
Signal( id , s_kill_tree );            // Kills the process that calls it, and all of its descendants
Signal( Type player , s_freeze );      // Freezes all processes of type player so that they are
                                       //     still displayed, but do not execute any code.