BatBrain - Revision history

Zarqon: "finished"

2018-08-31T16:54:34Z

"finished"

← Older revision		Revision as of 16:54, 31 August 2018
Line 251:		Line 251:

	{{HideLink\|finished}}{{Function\|		{{HideLink\|finished}}{{Function\|
	name=~~monster_stat~~\|		name=finished\|
	return_type=boolean\|		return_type=boolean\|
	}}		}}

Zarqon: BatBrain is a function library

2018-08-31T16:54:05Z

BatBrain is a function library

← Older revision		Revision as of 16:54, 31 August 2018
Line 1:		Line 1:
	{{TOCright}}{{DISPLAYTITLE:BatBrain (BatBrain.ash)}}		{{TOCright}}{{DISPLAYTITLE:BatBrain (BatBrain.ash)}}
	== About BatBrain ==		== About BatBrain ==
	BatBrain is a function library intended to greatly simplify writing a [[Custom_Combat_Script#Consult_Scripts\|consult script]]. A general introduction, changelog, download, and forum discussion can be found in the [http://kolmafia.us/showthread.php?6445 BatBrain thread], but this page is the best place for scripters interested in writing a consult script with BatBrain to start. NOTE: BatBrain is not built into KoLmafia, it is a separate ASH script which you must download and import to make these functions available.		BatBrain is a function library intended to greatly simplify writing a [[Custom_Combat_Script#Consult_Scripts\|consult script]]. A general introduction, changelog, download instructions, and forum discussion can be found in the [http://kolmafia.us/showthread.php?6445 BatBrain thread], but this page is the best place for scripters interested in writing a consult script with BatBrain to start. NOTE: BatBrain is not built into KoLmafia, it is a separate ASH script which you must download and import to make these functions available.

	== What It Does ==		== What It Does ==
Line 210:		Line 210:
	float spellres; // percent resistance to spells		float spellres; // percent resistance to spells
	float dodge; // chance of dodging melee attacks		float dodge; // chance of dodging melee attacks
	string onlyhurtby; // can only be damaged by X. possible: club, pottery, healing		string onlyhurtby; // can only be damaged by X. possible: aoe, club, pottery, healing
	string[string] dmgkey; // normalized damage type(s) vs. this monster (sauce, pasta, perfect)		string[string] dmgkey; // normalized damage type(s) vs. this monster (sauce, pasta, perfect)
			string note; // special note about this monster
	};		};
	monster_data mdata; // m's monster_data		monster_data mdata; // m's monster_data
	float mvalcache; // the value of the monster, including substats and meat/item drops		float mvalcache; // the value of the monster, including substats and meat/item drops
	</syntaxhighlight>		</syntaxhighlight>

Line 248:		Line 249:

	== Other Useful Functions ==		== Other Useful Functions ==

			{{HideLink\|finished}}{{Function\|
			name=monster_stat\|
			return_type=boolean\|
			}}
			This function simply returns true if your combat is over. Useful as a condition in your combat script's master while() loop.

	{{HideLink\|monster_stat}}{{Function\|		{{HideLink\|monster_stat}}{{Function\|
Line 287:		Line 294:
	}}		}}
	Use this function to check if an action has already happened during this combat. For example, if you have already used a seal tooth on a previous round, or you have enqueued a seal tooth, happened("use 2") will return true. In addition to canonical action ID's (BALLS syntax), BatBrain also gives you a few other handles for special events: crit, shieldcrit, smusted, stolen, icecapstun, hipster_stats, sealwail, and lackstool.		Use this function to check if an action has already happened during this combat. For example, if you have already used a seal tooth on a previous round, or you have enqueued a seal tooth, happened("use 2") will return true. In addition to canonical action ID's (BALLS syntax), BatBrain also gives you a few other handles for special events: crit, shieldcrit, smusted, stolen, icecapstun, hipster_stats, sealwail, and lackstool.

			[[Category:ASH Function Libraries]]

Zarqon: advevents changed slightly

2017-06-01T04:40:20Z

advevents changed slightly

← Older revision		Revision as of 04:40, 1 June 2017
Line 82:		Line 82:
	<syntaxhighlight>		<syntaxhighlight>
	record advevent { // record of changes due to an event		record advevent { // record of changes due to an event
	string id; // macro-ready ~~name --~~ attack/jiggle/skill s/use i		string id; // macro-ready; attack/jiggle/skill s/use i
	spread dmg; // raw dmg dealt ~~to the monster~~, before resists/vulns		string cid; // unique combat identifier: lastCombatStarted
	spread pdmg; // raw dmg taken ~~by the player~~, before resists/vulns		spread dmg; // raw dmg dealt, before resists/vulns
			spread pdmg; // raw dmg taken, before resists/vulns
	float att; // monster attack adjustment		float att; // monster attack adjustment
	float def; // monster defense adjustment		float def; // monster defense adjustment
Line 93:		Line 94:
	int rounds; // rounds consumed		int rounds; // rounds consumed
	substats stats; // substats gained/lost		substats stats; // substats gained/lost
	boolean endscombat; // ~~whether or not~~ this action ends ~~the~~ combat		boolean endscombat; // this action ends combat
	string custom; // ~~flag for special actions that~~ should not be used in normal automation		string custom; // if not empty, this action should not be used in normal automation -- value is action category (banish, attract, yellow, copy, runaway, etc)
	string note; // user-friendly name or special note		string note; // user-friendly name or special note
	};		};

Zarqon: Monster data has changed considerably

2017-06-01T04:18:19Z

Monster data has changed considerably

← Older revision		Revision as of 04:18, 1 June 2017
Line 185:		Line 185:

	<syntaxhighlight>		<syntaxhighlight>
	monster m // the monster currently being fought		monster m; // the monster currently being fought
	~~float mvalcache~~ // the ~~value of~~ the monster, ~~including substats and meat/item drops~~		record monster_data {
	spread ~~mres~~ // the monster's ~~resistances~~/~~vulnerabilities~~		int variable; // the +ML currently being run; if the same, the monster will be reloaded from cache
	~~spread mpen~~ // ~~the~~ monster's ~~penetrations~~		boolean nopotato; // potatos are useless here
			boolean nofamiliar; // your familiar is useless here
			spread aura; // passive damage dealt to you every round
			spread retal; // damage dealt to you if you hit with a melee attack
			spread res; // resistances to each element, expressed as -1.0 (vulnerability) to 1.0 (immunity)
			spread pen; // the monster's penetration ($element[none] for DA penetration)
			int drpen; // DR penetration. The doctor is IN!
			int howmany; // group monster size (default 1)
			int multiattack; // number of attacks per round (default 1)
			int maxround; // combat lasts till this round (default 30)
			int damagecap; // damage in amounts beyond this will be reduced...
			float capexp; // ...by this exponent
			float autohit; // chance of automatically hitting, regardless of moxie
			float automiss; // chance of automatically missing
			float nostagger; // chance of shrugging staggers. Usually 1.0 if anything
			float nostun; // chance of shrugging multi-round stuns
			float noitems; // chance of ignoring combat items
			float noskills; // chance of ignoring skills
			float delevelres; // percent resistance to deleveling
			float spellres; // percent resistance to spells
			float dodge; // chance of dodging melee attacks
			string onlyhurtby; // can only be damaged by X. possible: club, pottery, healing
			string[string] dmgkey; // normalized damage type(s) vs. this monster (sauce, pasta, perfect)
			};
			monster_data mdata; // m's monster_data
			float mvalcache; // the value of the monster, including substats and meat/item drops
	</syntaxhighlight>		</syntaxhighlight>

Line 208:		Line 233:
	int[item] stolen // all items you have acquired during this combat		int[item] stolen // all items you have acquired during this combat
	advevent adj // all adjustments to the current combat (used when queueing)		advevent adj // all adjustments to the current combat (used when queueing)
	~~record~~[string] happenings // events that have ~~already~~ happened		boolean[monster, int, string, int] happenings; // events that have happened in this fight. Indices: m, lastCombatStarted, action id, round => playeraction
	</syntaxhighlight>		</syntaxhighlight>

Line 218:		Line 243:
	advevent[int] queue // queued actions (affects round number and uses adj to track adjustments)		advevent[int] queue // queued actions (affects round number and uses adj to track adjustments)
	int[string] blacklist // blacklisted actions to be ignored		int[string] blacklist // blacklisted actions to be ignored
	string batround_insert // macro ~~commands~~ to ~~insert into every~~ round		string batround_insert // empty by default; calling scripts may insert additional macro code to batround (macro called each round between actions), formatted as "commands; "
	</syntaxhighlight>		</syntaxhighlight>

Zarqon: new monster attribute system

2014-10-12T05:54:36Z

new monster attribute system

← Older revision		Revision as of 05:54, 12 October 2014
Line 186:		Line 186:
	<syntaxhighlight>		<syntaxhighlight>
	monster m // the monster currently being fought		monster m // the monster currently being fought
	~~boolean isseal // true if the monster is a seal~~
	~~boolean nostun // true if the monster is immune to stuns and staggers~~
	~~boolean nomultistun // true if the monster is only immune to multi-round stuns~~
	~~boolean nomiss // true if the monster never misses (i.e. gremlins)~~
	~~boolean nohit // true if the monster never hits (i.e. crates)~~
	~~int howmanyfoes // the size of the group you are facing (usually 1)~~
	float mvalcache // the value of the monster, including substats and meat/item drops		float mvalcache // the value of the monster, including substats and meat/item drops
	spread mres // the monster's resistances/vulnerabilities		spread mres // the monster's resistances/vulnerabilities
	~~int damagecap~~ // the monster's ~~damage cap~~		spread mpen // the monster's penetrations
	~~float capexp // for damage caps; the exponent by which to reduce the amount over the cap~~
	</syntaxhighlight>		</syntaxhighlight>

Zarqon: /* Other Useful Functions */

2014-10-12T05:53:14Z

Other Useful Functions

← Older revision		Revision as of 05:53, 12 October 2014
Line 234:		Line 234:
	return_type=float\|		return_type=float\|
	parameter1={{Param\|string\|which}}\|		parameter1={{Param\|string\|which}}\|
	p1desc={{pspan\|which}} can be "att","def". or ~~"hp"~~\|		p1desc={{pspan\|which}} can be one of: att, def, hp, drpen, howmany, damagecap, capexp, autohit, automiss, nostun, noskills, noitems, nostagger, delevelres, spellres, dodge, or itemres\|
	}}		}}
	This function wraps ASH's monster_attack(), monster_defense(), and monster_hp() functions. Please use this function instead of the ASH functions, since the value may differ if you have enqueued actions causing BatBrain to predictively alter the monster's stats.		This function wraps ASH's monster_attack(), monster_defense(), and monster_hp() functions. Please use this function instead of the ASH functions, since the value may differ if you have enqueued actions causing BatBrain to predictively alter the monster's stats. This function is also used to return any of the special monster attributes listed above (these attributes are specified in [[batfactors]]).

	{{HideLink\|my_stat}}{{Function\|		{{HideLink\|my_stat}}{{Function\|

Zarqon: /* Useful Global Variables */

2014-01-28T07:52:32Z

Useful Global Variables

← Older revision		Revision as of 07:52, 28 January 2014
Line 221:		Line 221:

	<syntaxhighlight>		<syntaxhighlight>
	advevent[int] opts // all known combat options		advevent[int] opts // all known combat options currently available to you
	advevent[int] custom // custom actions which SS has determined apply to this combat		advevent[int] custom // custom actions which SS has determined apply to this combat
	advevent[int] queue // queued actions (affects round number and uses adj to track adjustments)		advevent[int] queue // queued actions (affects round number and uses adj to track adjustments)

Zarqon: /* Useful Global Variables */ basic explanations

2014-01-28T07:51:35Z

Useful Global Variables: basic explanations

← Older revision		Revision as of 07:51, 28 January 2014
Line 180:		Line 180:
	== Useful Global Variables ==		== Useful Global Variables ==

	BatBrain has a not-small number of global variables which may simplify writing your script. Most of these variables are automatically populated as soon as your script runs act().		BatBrain has a not-small number of global variables which may simplify writing your script. Most of these variables are automatically populated as soon as your script runs act(). Most of these values are set in BatBrain's set_monster() function.

	MONSTER		MONSTER

	monster m		<syntaxhighlight>
	boolean isseal		monster m // the monster currently being fought
	boolean nostun		boolean isseal // true if the monster is a seal
	boolean nomultistun		boolean nostun // true if the monster is immune to stuns and staggers
	boolean nomiss		boolean nomultistun // true if the monster is only immune to multi-round stuns
	boolean nohit		boolean nomiss // true if the monster never misses (i.e. gremlins)
	int howmanyfoes		boolean nohit // true if the monster never hits (i.e. crates)
	float mvalcache		int howmanyfoes // the size of the group you are facing (usually 1)
	spread mres		float mvalcache // the value of the monster, including substats and meat/item drops
	int damagecap		spread mres // the monster's resistances/vulnerabilities
	float capexp		int damagecap // the monster's damage cap
			float capexp // for damage caps; the exponent by which to reduce the amount over the cap
			</syntaxhighlight>

	ENVIRONMENT		ENVIRONMENT

	spread pres		<syntaxhighlight>
	string page		spread pres // your resistances/vulnerabilities
	int round		string page // the text of the most recent fight.php page load
	int maxround		int round // the current/simulated round
	float beatenup		int maxround // the maximum rounds the combat can extend
	float meatperhp		float beatenup // the cost of getting beaten up
	float meatpermp		float meatperhp // the value of 1 HP
			float meatpermp // the value of 1 MP
			</syntaxhighlight>

	TRACKING		TRACKING

	int[item] stolen		<syntaxhighlight>
	advevent adj		int[item] stolen // all items you have acquired during this combat
	record[string] happenings		advevent adj // all adjustments to the current combat (used when queueing)
			record[string] happenings // events that have already happened
			</syntaxhighlight>

	YOUR COMBAT OPTIONS		YOUR COMBAT OPTIONS

	advevent[int] opts		<syntaxhighlight>
	advevent[int] custom		advevent[int] opts // all known combat options
	advevent[int] queue		advevent[int] custom // custom actions which SS has determined apply to this combat
	int[string] blacklist		advevent[int] queue // queued actions (affects round number and uses adj to track adjustments)
	string batround_insert		int[string] blacklist // blacklisted actions to be ignored
			string batround_insert // macro commands to insert into every round
			</syntaxhighlight>

	== Other Useful Functions ==		== Other Useful Functions ==

Zarqon: add global variables; need to format into table later

2013-12-10T05:09:44Z

add global variables; need to format into table later

@@ Line 177: / Line 177: @@
 }}
 Returns the profit of performing the action {{pspan|haps}} at the current point in the combat.  It looks ahead one round (including the monster's event, your familiar's event, and any equipment and effects) and determines what you gained and lost, and converts all of that to a single number, which it returns.  This is a very useful function for combining with other criteria and sorting opts[].  HP and MP gain/loss are evaluated based on your _meatpermp and _meatperhp properties, which are set by Bale's Universal Recovery Script.  If you are not using this script, basic calculations are made using the price of common restoratives.  HP/MP regeneration is also factored into the profit appropriately.  By default, this function includes profit from deleveling (i.e. reducing the monster's attack by X means it will deal Y less damage, effectively earning you Y HP).  However, this may be undesirable if you intend to stun beforehand, so an optional {{pspan|nodelevel}} flag was included.
 == Other Useful Functions ==

Zarqon: /* Advevents */

2013-09-10T05:14:23Z

Advevents

← Older revision		Revision as of 05:14, 10 September 2013
Line 105:		Line 105:
	Second, substats is another datatype defined by BatBrain, and it's simply a float[stat] map.		Second, substats is another datatype defined by BatBrain, and it's simply a float[stat] map.

	The custom field will be empty for most actions, so scripts ought be checking a.custom != "" before using an action in regular automation. For special actions, the custom field will contain the type of custom action (and sometimes additional information). Some custom types currently being used are: attract, banish, copy, yellow, and runaway.		The custom field will be empty for most actions, so scripts ought to be checking a.custom == "" before using an action in regular automation. For special actions, the custom field will contain the type of custom action (and sometimes additional information). Some custom types currently being used are: attract, banish, copy, yellow, and runaway.

	Finally, the note field is not really used by BatBrain, but is used by BatMan RE to display extra information about certain actions (such as notices of estimates due to unspaded numbers, or ongoing damage not predicted by BatBrain, etc).		Finally, the note field is not really used by BatBrain, but is used by BatMan RE to display extra information about certain actions (such as notices of estimates due to unspaded numbers, or ongoing damage not predicted by BatBrain, etc).