Custom Combat Script - Revision history

Philmasterplus: /* Macros in Consult Scripts */

2021-03-15T08:04:57Z

Macros in Consult Scripts

← Older revision		Revision as of 08:04, 15 March 2021
Line 226:		Line 226:
	</syntaxhighlight></div>		</syntaxhighlight></div>

	Between macro commands you need to insert either /n or a semi-colon as in the above example. Your submitted macro can be as complicated as you wish.		Between macro commands you need to insert either <code>\n</code> or a semi-colon as in the above example. Your submitted macro can be as complicated as you wish.


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

Fredg1: /* Resolution of a Combat Consultation Script */

2020-01-24T07:05:25Z

Resolution of a Combat Consultation Script

@@ Line 206: / Line 206: @@
 === Resolution of a Combat Consultation Script ===
 The consult script can automate as many, or as few rounds of combat as desired to achieve its goal. When it finishes executing, if the monster is not yet dead, then the CCS will continue combat from the current round. Note that the current round is not always the next line in a script. For instance, if the consult script is called at round 1 and executes three actions, then it will return to the CCS at round 4. This is why most CCSs containing consult script prefer to have only a line after the consult script, usually a simple method of killing a monster.
 === Macros in Consult Scripts ===

Bale: /* Consult Scripts */ small clarification

2016-11-29T22:39:27Z

Consult Scripts: small clarification

← Older revision		Revision as of 22:39, 29 November 2016
Line 143:		Line 143:
	The main() function in the ASH script being consulted must accept three parameters:		The main() function in the ASH script being consulted must accept three parameters:

	void main(int round, monster mob, string ~~combat~~)		void main(int round, monster mob, string page_text)

	These values will be supplied by mafia when the consult script is called.		These values will be supplied by mafia when the consult script is called.

Bale: /* Example of CCS Macro */ Fat stacks of cash have been neutered by KoL

2014-12-04T01:09:07Z

Example of CCS Macro: Fat stacks of cash have been neutered by KoL

← Older revision		Revision as of 01:09, 4 December 2014
Line 112:		Line 112:
	:if hascombatitem dictionary		:if hascombatitem dictionary
	::item dictionary		::item dictionary
	~~::goto _endstasisitem~~
	~~:endif~~
	~~:if hascombatitem fat stacks of cash~~
	~~::item fat stacks of cash~~
	::goto _endstasisitem		::goto _endstasisitem
	:endif		:endif

Bale: I didn't even remember it was possible to use ASH Constants in CCS. Huh. I learned something today.

2014-11-08T06:34:06Z

I didn't even remember it was possible to use ASH Constants in CCS. Huh. I learned something today.

@@ Line 48: / Line 48: @@
 * note
 * twiddle
 == Macros in CCS ==

Bale: Remove information on "Employ Scripts" because after all these years it will probably never be implemented.

2014-11-07T18:59:37Z

Remove information on "Employ Scripts" because after all these years it will probably never be implemented.

← Older revision		Revision as of 18:59, 7 November 2014
Line 199:		Line 199:
	Between macro commands you need to insert either /n or a semi-colon as in the above example. Your submitted macro can be as complicated as you wish.		Between macro commands you need to insert either /n or a semi-colon as in the above example. Your submitted macro can be as complicated as you wish.

	~~== Employ Scripts ==~~
	~~<div style="padding: 1em; border: solid 1px red; color: red; font-weight: bold;">Please note! This section is speculative; Employ Scripts have not yet been implemented.</div>~~
	An employ script is a like a consultation script, with benefits. While a consultation script operates turn-by-turn, an employ script operates only at the beginning of the combat and generates a combat macro.

	Employ scripts do not yet exist in KolMafia at this time, but they are a goal that jasonharper is working towards as he [http://kolmafia.us/showthread.php?4098-Dynamic-Combat-in-the-Age-of-Macros describes on the mafia forum].


	~~It is currently proposed that they will have the following format:~~

	~~'''string main( string opponent, string pageText, string macroSoFar, string parameter )'''~~

	* opponent is the name of the monster being fought, just as in a consult script or combat filter function.
	* pageText is the raw HTML of the initial combat page. This isn't necessarily going to be useful (since it's a one-time snapshot), however you may want to examine the Skills popup to see what conditionally-available skills are actually available.
	* macroSoFar is the current text of the macro being built - a mafia-generated header with some useful subroutines defined, followed by macro translations of all the prior lines in the CCS.
	* parameter contains any extra text from the CCS line; it could be used to customize the behavior of the script, more conveniently than using a "note" line with a consult script. It also serves the less obvious purpose of making the parameter count something other than 3, so that mistakenly attempting to employ a consult script, or consult an employ script, will fail before any code runs.
	* The return value entirely replaces the macro being built. It would probably be an error for this to be any shorter than the original value of macroSoFar.

	~~The simplest thing an employ script could do is to append some commands to macroSoFar, and return that. Other possibilities include:~~
	* It could look back through the previously-generated macro commands to decide what to do. For example, it could refrain from adding a "pickpocket" action if that has already been done
	* If it wanted to set up a global abort condition, active throughout the combat, it could insert the command at the beginning of the macro.
	* There will be a subroutine called "mafiaround" defined in the header, and called before every combat action to handle things like automatic antidote use. The script could insert commands into that subroutine, for example to implement an eye color check for using He-Boulder major rays.
	* There will likely be other defined subroutines for the script to call or modify.

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

PsyMar: example script calculated several things wrong; immaculate seasoning does not override gazpacho's, for example. Also, saucespheres aren't needed for splash, but being a sauceror is

2013-06-10T10:24:19Z

example script calculated several things wrong; immaculate seasoning does not override gazpacho's, for example. Also, saucespheres aren't needed for splash, but being a sauceror is

@@ Line 134: / Line 134: @@
 // Save this as SauceSplash.ash
 boolean sauceSplash() {
-    if(!(have_effect($effect[Jabañero Saucesphere]) >0
+    if(!my_class() == $class[Sauceror])
           return false;
     int normal = numeric_modifier("spell damage");
@@ Line 142: / Line 141: @@
     int cold = numeric_modifier("cold spell damage");
     int hot = numeric_modifier("hot spell damage");
     if(have_skill($skill[Immaculate Seasoning])
        && cold != hot && max(cold, hot) + normal >= 25)
           return true;
-    if(monster_element() == $element[cold] && cold + normal >= 25
+    else return false;
+}

Bale: /* Consult Scripts */

2011-03-08T03:08:24Z

Consult Scripts

@@ Line 184: / Line 184: @@
 === Resolution of a Combat Consultation Script ===
 The consult script can automate as many, or as few rounds of combat as desired to achieve its goal. When it finishes executing, if the monster is not yet dead, then the CCS will continue combat from the current round. Note that the current round is not always the next line in a script. For instance, if the consult script is called at round 1 and executes three actions, then it will return to the CCS at round 4. This is why most CCSs containing consult script prefer to have only a line after the consult script, usually a simple method of killing a monster.
 == Employ Scripts ==

Rinn: /* Available Commands */

2011-01-19T03:42:21Z

Available Commands

← Older revision		Revision as of 03:42, 19 January 2011
Line 39:		Line 39:
	** Disco Concentration, Disco Nirvana, Disco Inferno, Disco Bleeding, Disco Blindness		** Disco Concentration, Disco Nirvana, Disco Inferno, Disco Bleeding, Disco Blindness
	** Rave Knockout, Rave Bleeding, Rave Concentration, Rave Steal, Rave Nirvana, Rave Stats		** Rave Knockout, Rave Bleeding, Rave Concentration, Rave Steal, Rave Nirvana, Rave Stats
			** [http://kolmafia.us/showthread.php?5709-Add-rave-combo-learning-to-quot-special-action-quot&p=42107&viewfull=1#post42107 random rave]
	* abort		* abort
	* abort after		* abort after

Bale: small wording fix

2010-11-16T05:28:17Z

small wording fix

← Older revision		Revision as of 05:28, 16 November 2010
Line 111:		Line 111:

	== Consult Scripts ==		== Consult Scripts ==
	While ~~this~~ may seem reasonably flexible, sometimes you will want to do something too complicated to express in ~~this~~ format. For instance if you want your character to take different actions based on your characters current stats or current monster level, a consult script can automatically figure it out. There are few limits to what a consult script can enable. The downside to using a consult script is that KoLmafia will not be able to generate a combat macro to pass to KoL. As a result multi-round combat will take somewhat longer.		While a CCS may seem reasonably flexible, sometimes you will want to do something too complicated to express in that format. For instance if you want your character to take different actions based on your characters current stats or current monster level, a consult script can automatically figure it out. There are few limits to what a consult script can enable. The downside to using a consult script is that KoLmafia will not be able to generate a combat macro to pass to KoL. As a result multi-round combat will take somewhat longer.

	A consult script is called by using the "consult" command in your CCS, as follows:		A consult script is called by using the "consult" command in your CCS, as follows: