Import - Revision history

Bale: main@filename()

2014-11-27T03:14:33Z

main@filename()

← Older revision		Revision as of 03:14, 27 November 2014
Line 10:		Line 10:

	Because '''import''' looks inside the /scripts directory and all its subfolders for the given script name, moving your scripts around inside the /scripts directory will not affect other scripts that rely on them. If there are multiple scripts with the same file name, KoLmafia will use the first script found. You can use your OS-specific directory path separators (usually slashes(/) and backslashes(\)) to explicitly '''import''' a script inside a subdirectory.		Because '''import''' looks inside the /scripts directory and all its subfolders for the given script name, moving your scripts around inside the /scripts directory will not affect other scripts that rely on them. If there are multiple scripts with the same file name, KoLmafia will use the first script found. You can use your OS-specific directory path separators (usually slashes(/) and backslashes(\)) to explicitly '''import''' a script inside a subdirectory.

			== Executing main() ==
			While the main() function of an imported script is not run on import, it can be implicitly called by the importing script. To do so, the script calls it as a function with the name <code>main@filename()</code>.

			No spaces are allowed around the @ as the whole thing is a single token.

			There are some rules for how filename is interpreted.
			* Normally, this is the file name of the imported file whose main() is to be executed.
			* If the imported script uses the "script" directive, then 'filename' is overriden by that name.
			* Any .ash suffix is dropped.
			* Any non-alphanumeric characters are replaced with underscores.

	==Example==		==Example==

Bale: added all possible invocations

2010-11-12T05:50:58Z

added all possible invocations

← Older revision		Revision as of 05:50, 12 November 2010
Line 1:		Line 1:
	{{DISPLAYTITLE:import}}		{{DISPLAYTITLE:import}}
	'''import <filename>'''		'''import <filename>'''<br />
			'''import <filename>;'''<br />
			'''import "filename"'''<br />
			'''import "filename";'''

			All the invocations above will work equally well. It works with or without a semi-colon and you can use either angle brackets or quotes.

	'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will not import that file again. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the primary script's <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored. However, any of the imported top-level commands will be executed and all of the imported global variables will be accessible to the primary script. An import can only be used as a top-level command; attempting to import another script inside a closure (e.g. a function or a loop) will result in an error.		'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will not import that file again. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the primary script's <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored. However, any of the imported top-level commands will be executed and all of the imported global variables will be accessible to the primary script. An import can only be used as a top-level command; attempting to import another script inside a closure (e.g. a function or a loop) will result in an error.

PhilmASTErpLus: Reworded--automatic "#pragma once" feature is not only important for name collisions, but also for preventing a script from being executed multiple times. Also, it's okay to remove 'Formatting Needed

2010-09-16T20:44:48Z

Reworded--automatic "#pragma once" feature is not only important for name collisions, but also for preventing a script from being executed multiple times. Also, it's okay to remove 'Formatting Needed

← Older revision		Revision as of 20:44, 16 September 2010
Line 2:		Line 2:
	'''import <filename>'''		'''import <filename>'''

	'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will ~~automatically avoid function name collisions~~. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the primary script's <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored. However, any of the imported top-level commands will be executed and all of the imported global variables will be accessible to the primary script.		'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will not import that file again. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the primary script's <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored. However, any of the imported top-level commands will be executed and all of the imported global variables will be accessible to the primary script. An import can only be used as a top-level command; attempting to import another script inside a closure (e.g. a function or a loop) will result in an error.

	Because '''import''' looks inside the /scripts directory and all its subfolders for the given script name, moving your scripts around inside the /scripts directory will not affect other scripts that rely on them. If there are multiple scripts with the same file name, KoLmafia will use the first script found. You can use your OS-specific directory path separators (usually slashes(/) and backslashes(\)) to explicitly '''import''' a script inside a subdirectory.		Because '''import''' looks inside the /scripts directory and all its subfolders for the given script name, moving your scripts around inside the /scripts directory will not affect other scripts that rely on them. If there are multiple scripts with the same file name, KoLmafia will use the first script found. You can use your OS-specific directory path separators (usually slashes(/) and backslashes(\)) to explicitly '''import''' a script inside a subdirectory.
Line 21:		Line 21:
	# ...		# ...
	</syntaxhighlight>}}		</syntaxhighlight>}}
	~~{{Format}}~~

	[[Category:Scripting]]		[[Category:Scripting]]

PhilmASTErpLus: Subdirectory stuff. Does a similar logic applies to file_to_map()/map_to_file()? I believe there was a forum discussion about security and preventing KoLmafia from accessing the parent directory.

2010-09-13T07:40:21Z

Subdirectory stuff. Does a similar logic applies to file_to_map()/map_to_file()? I believe there was a forum discussion about security and preventing KoLmafia from accessing the parent directory.

← Older revision		Revision as of 07:40, 13 September 2010
Line 3:		Line 3:

	'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will automatically avoid function name collisions. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the primary script's <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored. However, any of the imported top-level commands will be executed and all of the imported global variables will be accessible to the primary script.		'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will automatically avoid function name collisions. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the primary script's <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored. However, any of the imported top-level commands will be executed and all of the imported global variables will be accessible to the primary script.

			Because '''import''' looks inside the /scripts directory and all its subfolders for the given script name, moving your scripts around inside the /scripts directory will not affect other scripts that rely on them. If there are multiple scripts with the same file name, KoLmafia will use the first script found. You can use your OS-specific directory path separators (usually slashes(/) and backslashes(\)) to explicitly '''import''' a script inside a subdirectory.

	==Example==		==Example==

			<!-- code sample edited without permission by PhilmASTErpLus. -->
	{{CodeSample\|code=<syntaxhighlight>		{{CodeSample\|code=<syntaxhighlight>
	# snippet from my aftercore.ash file		# snippet from my aftercore.ash file
			import <lib/utilities.ash> // import a utility function library in the scripts/lib/ directory
	import <aftercore_config.ash> // import the configuration file (loaded with variables) into the script		import <aftercore_config.ash> // import the configuration file (loaded with variables) into the script
	import <aftercore_bounty.ash> // import bounty functionality (loaded with functions) into the script		import <aftercore_bounty.ash> // import bounty functionality (loaded with functions) into the script

Bale at 09:01, 17 July 2010

2010-07-17T09:01:40Z

← Older revision		Revision as of 09:01, 17 July 2010
Line 19:		Line 19:
	{{Format}}		{{Format}}

	[[Category:~~ASH~~ Scripting]]		[[Category:Scripting]]

Bale: tidying stuff and answering RFI

2010-06-28T20:42:34Z

tidying stuff and answering RFI

← Older revision		Revision as of 20:42, 28 June 2010
Line 1:		Line 1:
			{{DISPLAYTITLE:import}}
	'''import <filename>'''		'''import <filename>'''

	'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will automatically avoid function name collisions. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the ~~top-level~~ <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored.		'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will automatically avoid function name collisions. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the primary script's <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored. However, any of the imported top-level commands will be executed and all of the imported global variables will be accessible to the primary script.

	==Example==		==Example==
Line 17:		Line 18:
	</syntaxhighlight>}}		</syntaxhighlight>}}
	{{Format}}		{{Format}}

			[[Category:ASH Scripting]]

PhilmASTErpLus: Properly formatted code with Template:CodeSample. Also added some fuzzy information about main(), please look at talk page.

2010-06-28T17:34:01Z

Properly formatted code with Template:CodeSample. Also added some fuzzy information about main(), please look at talk page.

← Older revision		Revision as of 17:34, 28 June 2010
Line 1:		Line 1:
	'''import <filename>'''		'''import <filename>'''
	~~<br />'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called.~~

	<p>Example:		'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. "Nested" imports are possible; a script that is being imported may import another script. If a single file is imported more than once, KoLmafia will automatically avoid function name collisions. Note that when a script that has a <code>main()</code> function is imported into another script with another <code>main()</code> function, only the top-level <code>main()</code> is executed, and all <code>main()</code> functions from imported scripts will be ignored.
	<~~pre~~># snippet from my aftercore.ash file
			==Example==

			{{CodeSample\|code=<syntaxhighlight>
			# snippet from my aftercore.ash file
	import <aftercore_config.ash> // import the configuration file (loaded with variables) into the script		import <aftercore_config.ash> // import the configuration file (loaded with variables) into the script
	import <aftercore_bounty.ash> // import bounty functionality (loaded with functions) into the script		import <aftercore_bounty.ash> // import bounty functionality (loaded with functions) into the script
Line 11:		Line 14:
	boolean using_upcs_curr = false;		boolean using_upcs_curr = false;

	# ...</~~pre></p~~>		# ...
			</syntaxhighlight>}}
	{{Format}}		{{Format}}

StDoodle at 16:23, 6 May 2010

2010-05-06T16:23:52Z

← Older revision		Revision as of 16:23, 6 May 2010
Line 12:		Line 12:

	# ...</pre></p>		# ...</pre></p>
			{{Format}}

MapleMario: New page: '''import '''
'''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called.

Example:

#...

2009-05-09T22:31:20Z

New page: '''import <filename>''' '''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called. Example: <pre>#...

New page

'''import <filename>'''
 '''Import''' is a command that is used to import (hence the name) an entire file's contents into the file in which '''import''' is called.

Example:
<pre># snippet from my aftercore.ash file
import <aftercore_config.ash> // import the configuration file (loaded with variables) into the script
import <aftercore_bounty.ash> // import bounty functionality (loaded with functions) into the script

int first_meat = my_meat();
int first_advs = my_adventures();
boolean using_upcs_curr = false;

# ...</pre>