Lich:Software/Scripting reference - Revision history

HORIBU1: /* wait_until */

2024-09-27T13:58:56Z

wait_until

← Older revision		Revision as of 08:58, 27 September 2024
Line 213:		Line 213:
	=== wait_until ===		=== wait_until ===
	<div {{log}}>		<div {{log}}>
	wait_until { checkmana(50) }		wait_until("Waiting until 50 mana or more!") { checkmana(50) }
	</div>		</div>
	*'''Returns:''' true/false		*'''Returns:''' true/false
	*'''Description:''' Identical in all ways to 'wait_while', but does the opposite (waits UNTIL the given code block is true, not WHILE it's true). Also takes the optional string if desired.		*'''Description:''' Identical in all ways to 'wait_while', but does the opposite (waits UNTIL the given code block is true, not WHILE it's true). Also takes the optional string if desired.


	== Match ==		== Match ==

2024-09-27T13:58:18Z

wait_while

← Older revision		Revision as of 08:58, 27 September 2024
Line 206:		Line 206:
	</div>		</div>
	<div {{log}}>		<div {{log}}>
	wait_while "You do not have full health: waiting until you do." { percenthealth != 100 }		wait_while("You do not have full health: waiting until you do.") { percenthealth != 100 }
	</div>		</div>
	*'''Returns:''' true/false		*'''Returns:''' true/false

2024-06-24T14:06:35Z

Global variables: updated for current proper usage

← Older revision		Revision as of 09:06, 24 June 2024
Line 1,277:		Line 1,277:
	=== $frontend ===		=== $frontend ===
	Frontend detected by Lich.		Frontend detected by Lich.

⚫	=== ~~$lich_dir~~ ===
⚫	Path of the current Lich directory.

	=== $login_time ===		=== $login_time ===
	Local time the current Lich session started.		Local time the current Lich session started.

	=== ~~$script_dir~~ ===		== Lich Constants ==

⚫	Path to directory Lich is using to ~~get~~ scripts.
		⚫	=== LICH_DIR ===
		⚫	Path of the current Lich directory.

			=== SCRIPT_DIR ===
		⚫	Path to directory Lich is using to for scripts.

			=== DATA_DIR ===
			Path to the directory Lich is using for data.

			=== LOG_DIR ===
			Path to the directory Lich is using for logs.

	=== ~~$version~~ ===		=== LICH_VERSION ===
	Lich version.		Lich version.

2024-06-24T14:03:42Z

variable: Removed comments from code examples and added to description field to match rest of Lich wiki documention page.

← Older revision		Revision as of 09:03, 24 June 2024
Line 4:		Line 4:
	variable[1]		variable[1]
	</div>		</div>

	Code Example:
	<div {{log}}>		<div {{log}}>
			Script.current.vars[0]
	<nowiki>#</nowiki>contains all variables passed to a script in a single string
			</div>

			<div {{log}}>
	script.vars[0]
			Script.current.vars[1]

	<nowiki>#</nowiki>a space separated list of the values passed to the script exist in index 1 through n where n is the number of space separated items

	script.vars[1..n]
	</div>		</div>

	*'''Returns:''' an array, possibly empty		*'''Returns:''' an array, possibly empty
	*'''Synonyms:''' Script.current.vars		*'''Synonyms:''' Script.current.vars, script.vars
	*'''Description:''' ~~It's an~~ array containing the command line variables the user entered when starting the script ~~(begins~~ at ~~variable[~~1], ~~unlike~~ ~~standard~~ ~~arrays;~~ as is ~~the~~ ~~behavior~~ of ~~Wizard,~~ variable~~[0]~~ is the ~~entire~~ ~~line~~ the ~~user~~ ~~entered)~~.		*'''Description:''' An array containing the command line variables the user entered when starting the script. Index position 0 contains all the variables passed to it in a single string. Index positions 1 thru n correlate to space separated list of the values passed to the script. The third example above showing proper syntax for recalling the first variable passed to the script. While variable and script.vars still work, the current best practice is to use Script.current.vars to match appropriate Lich API usage.

	== echo ==		== echo ==

2024-06-24T13:50:41Z

variable

← Older revision		Revision as of 08:50, 24 June 2024
Line 8:		Line 8:
	<div {{log}}>		<div {{log}}>
	<nowiki>#</nowiki>contains all variables passed to a script in a single string		<nowiki>#</nowiki>contains all variables passed to a script in a single string

	script.vars[0]		script.vars[0]

	<nowiki>#</nowiki>a space separated list of the values passed to the script exist in index 1 through n where n is the number of space separated items		<nowiki>#</nowiki>a space separated list of the values passed to the script exist in index 1 through n where n is the number of space separated items

	script.vars[1..n]		script.vars[1..n]
	</div>		</div>

2024-06-24T13:50:04Z

variable

← Older revision		Revision as of 08:50, 24 June 2024
Line 6:		Line 6:

	Code Example:		Code Example:
			<div {{log}}>
	<syntaxhighlight lang="ruby">
	#contains all variables passed to a script in a single string		<nowiki>#</nowiki>contains all variables passed to a script in a single string
	script.vars[0]		script.vars[0]

	#a space separated list of the values passed to the script exist in index 1 through n where n is the number of space separated items		<nowiki>#</nowiki>a space separated list of the values passed to the script exist in index 1 through n where n is the number of space separated items
	script.vars[1..n]		script.vars[1..n]
			</div>
	</syntaxhighlight>


	*'''Returns:''' an array, possibly empty		*'''Returns:''' an array, possibly empty

2024-06-24T13:49:07Z

variable

← Older revision		Revision as of 08:49, 24 June 2024
Line 5:		Line 5:
	</div>		</div>

			Code Example:
	<syntaxhighlight lang="ruby">		<syntaxhighlight lang="ruby">
	#contains all variables passed to a script in a single string		#contains all variables passed to a script in a single string

2024-06-24T13:48:39Z

variable

← Older revision		Revision as of 08:48, 24 June 2024
Line 5:		Line 5:
	</div>		</div>

			<syntaxhighlight lang="ruby">
	<div {{log}}>
	#contains all variables passed to a script in a single string		#contains all variables passed to a script in a single string
	script.vars[0]		script.vars[0]
Line 11:		Line 11:
	#a space separated list of the values passed to the script exist in index 1 through n where n is the number of space separated items		#a space separated list of the values passed to the script exist in index 1 through n where n is the number of space separated items
	script.vars[1..n]		script.vars[1..n]
			</syntaxhighlight>
	</div>

2024-06-24T13:39:59Z

variable

@@ Line 4: / Line 4: @@
 variable[1]
 </div>
 *'''Returns:''' an array, possibly empty
 *'''Synonyms:''' Script.current.vars

2024-01-03T21:59:21Z

GameObj arrays: add GameObj.target

← Older revision		Revision as of 16:59, 3 January 2024
Line 1,167:		Line 1,167:

	*'''Returns:''' an array of objects of the GameObj class representing the hostile npcs in the room, the mobs, the monsters, whatever you want to call them.		*'''Returns:''' an array of objects of the GameObj class representing the hostile npcs in the room, the mobs, the monsters, whatever you want to call them.

			==== GameObj.target ====

			*'''Returns:''' an object of the GameObj class representing the current target you have selected, if any.

	=== Finding game objects with GameObj ===		=== Finding game objects with GameObj ===