Macro Module - Revision history

Elverion at 03:49, 8 March 2017

2017-03-08T03:49:56Z

Elverion at 20:46, 23 January 2015

2015-01-23T20:46:44Z

Elverion: /* main */

2014-06-29T15:48:16Z

‎main

Elverion at 17:27, 28 June 2014

2014-06-28T17:27:26Z

Elverion: Protected "Macro Module" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2014-06-03T18:32:52Z

Protected "Macro Module" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

Elverion: Created page with "== init == '''macro.init(...)''' This is an empty function that will be called once at the start of your script's execution. You should replace this with your own function. A..."

2014-06-03T18:00:52Z

Created page with "== init == '''macro.init(...)''' This is an empty function that will be called once at the start of your script's execution. You should replace this with your own function. A..."

New page

== init ==
'''macro.init(...)'''

This is an empty function that will be called once at the start of your script's execution. You should replace this with your own function.
Any arguments passed to the script execution via command line will be also passed to this function.

== main ==
'''macro.init(number dt)'''

This is an empty function that will be called once per logic cycle (~1,000 times a second). You should replace this with your own function. The only parameter received is the delta time; the amount of time (in seconds) that has passed since the last call to this function.

You are expected to return 'true' to continue script execution, or 'false' to stop script execution. You do not need to insert any rests to reduce CPU usage; this is already handled for you.

It is recommended that you do ''not'' use any long while loops; the main update function should execute quickly and constantly.

== event ==
'''macro.event(string eventType, ...)'''

This is an empty function that will be called once for every event that is triggered. You should replace this with your own function.

'eventType' is a string that identifies which event was triggered, and the number and types of extra parameters depends on the event type.

== getVersion ==
'''string macro.getVersion()'''

Returns the version as a MAJOR.MINOR.BUILD string format (ie 2.1.4)

← Older revision		Revision as of 20:46, 23 January 2015
Line 29:		Line 29:

	Returns the version as a MAJOR.MINOR.BUILD string format (ie 2.1.4)		Returns the version as a MAJOR.MINOR.BUILD string format (ie 2.1.4)
		+
		+
		+	== is32bit ==
		+	'''macro.is32bit()'''
		+
		+	Returns whether or not the MicroMacro instance is 32-bit.
		+
		+
		+	== is64bit ==
		+	'''macro.is64bit()'''
		+
		+	Returns whether or not the MicroMacro instance is 64-bit.

← Older revision		Revision as of 17:27, 28 June 2014
Line 1:		Line 1:
		+	See also: [[Basic_Info]] for information on how to use these functions.
		+
	== init ==		== init ==
	'''macro.init(...)'''		'''macro.init(...)'''

@@ Line 16: / Line 16: @@
 It is recommended that you do ''not'' use any long while loops; the main update function should execute quickly and constantly.
 == event ==
@@ Line 23: / Line 24: @@
 'eventType' is a string that identifies which event was triggered, and the number and types of extra parameters depends on the event type.

@@ Line 9: / Line 9: @@
 == main ==
-'''macro.init(number dt)'''
+'''macro.main(number dt)'''
 This is an empty function that will be called once per logic cycle (~1,000 times a second). You should replace this with your own function. The only parameter received is the delta time; the amount of time (in seconds) that has passed since the last call to this function.
@@ Line 16: / Line 16: @@
 It is recommended that you do ''not'' use any long while loops; the main update function should execute quickly and constantly.
 == event ==

← Older revision	Revision as of 18:32, 3 June 2014
(No difference)