DelayEvent - Revision history

Proleric1: /* Examples */

2010-09-29T15:53:25Z

‎Examples

Proleric1 at 15:52, 29 September 2010

2010-09-29T15:52:21Z

Sunjammer: /* Examples */

2009-12-08T23:02:03Z

‎Examples

Sunjammer: /* Examples */ removed unnecessary includes, fixed target and added comments

2009-12-08T21:37:51Z

‎Examples: removed unnecessary includes, fixed target and added comments

Sunjammer: /* Remarks */

2009-12-08T21:28:47Z

‎Remarks

BryanDerksen: a fancied up and trimmed down version of the heartbeat example. Works for everyone?

2009-12-08T18:52:45Z

a fancied up and trimmed down version of the heartbeat example. Works for everyone?

Sunjammer: /* Examples */ move "example" to talk because isn't of sufficient quality to be used as reference

2009-12-08T18:08:17Z

‎Examples: move "example" to talk because isn't of sufficient quality to be used as reference

Georage at 08:54, 8 December 2009

2009-12-08T08:54:55Z

Georage at 08:53, 8 December 2009

2009-12-08T08:53:14Z

Sunjammer: removed tag

2009-11-30T20:33:06Z

removed tag

@@ Line 36: / Line 36: @@
 == Examples ==
 <!-- This section contains examples transcluded from the snippet library. -->
-If the intention is simply to delay the execution of a script, the function can be called with a dummy event parameter. For example,
+If the intention is simply to delay the execution of a script, the function can be called with a dummy event parameter. For example, the snippet
 <dascript>
 DelayEvent(1.0, OBJECT_SELF, Event(EVENT_TYPE_INVALID), "my_script");

@@ Line 36: / Line 36: @@
 == Examples ==
 <!-- This section contains examples transcluded from the snippet library. -->
 <code>DelayEvent</code> can be used to create a heartbeat event that is sent to an object at regular intervals. For example, if you created the following script named "event_heartbeat" it would fire every six seconds after it has been initiated.

@@ Line 55: / Line 55: @@
               // schedule a delayed event on this object to call this script again
               DelayEvent(6.0, OBJECT_SELF, Event(EVENT_TYPE_HEARTBEAT), "event_heartbeat");
               break;
+          }

@@ Line 36: / Line 36: @@
 == Examples ==
 <!-- This section contains examples transcluded from the snippet library. -->
+<code>DelayEvent</code> can be used to create a heartbeat event that is sent to an object at regular intervals. For example, if you created the following script named "event_heartbeat" it would fire every six seconds after it has been initiated.
-This function can be used to create a "heartbeat" event that is sent to a script at regular intervals. For example, if you created the following script named "event_heartbeat":
 <dascript>
 #include "events_h"
 void main()
+{
      event ev = GetCurrentEvent();
-     int nEventType = GetEventType(ev); //extract event type from current event
+     int nEventType = GetEventType(ev);
      switch(nEventType)
+     {
           case EVENT_TYPE_HEARTBEAT:
+          {
-              //Insert whatever code you need to execute on heartbeats here
+              // insert whatever code you need to execute on every heartbeat here
-              DelayEvent(6.0f, GetHero(), Event(EVENT_TYPE_HEARTBEAT), "event_heartbeat");
               break;
+          }
@@ Line 59: / Line 60: @@
+}
 </dascript>
+To associate a heartbeat with a particular object you can use that object's event-handling script and omit the <code>scriptname</code> parameter.
-This event would fire every six seconds. To associate a heartbeat with a particular creature you can use that creature's event-handling script and omit the scriptname parameter.
 <!-- == See also == -->

@@ Line 30: / Line 30: @@
 == Remarks ==
 <!-- This section contains additional comments, observations and known issues. -->
 With a negative or zero time in fSeconds, the event will run on the next AI update.
 == Examples ==

← Older revision		Revision as of 08:54, 8 December 2009
Line 37:		Line 37:

	DelayEvent(6.0f,GetHero(),Event(EVENT_TYPE_HEARTBEAT),"my_heartbeat");		DelayEvent(6.0f,GetHero(),Event(EVENT_TYPE_HEARTBEAT),"my_heartbeat");
		+
		+	Detailed example: [http://social.bioware.com/forum/1/topic/71/index/310150/1#402992]

	<!-- == See also == -->		<!-- == See also == -->

← Older revision		Revision as of 20:33, 30 November 2009
(One intermediate revision by the same user not shown)
Line 1:		Line 1:
−	~~{{Generated with joins}}~~
	{{dafunction		{{dafunction
	\|name=DelayEvent		\|name=DelayEvent