Familiar - Revision history

Aventuristo: Add to Data Types category; add proxy record boilerplate

2017-09-30T00:42:47Z

Add to Data Types category; add proxy record boilerplate

← Older revision		Revision as of 00:42, 30 September 2017
Line 32:		Line 32:

	==Proxy Record Fields==		==Proxy Record Fields==

			Here are the proxy record fields for familiars. Proxy records are discussed in more
			detail [[Proxy Records\|here]].

	{\| cellpadding="3" cellspacing="0" border="1px" class="sortable"		{\| cellpadding="3" cellspacing="0" border="1px" class="sortable"
Line 147:		Line 150:
	\|}		\|}

	[[Category:Scripting]]		[[Category:Scripting]] [[Category:Data Types]]

Aventuristo: Replaced redirect with familiar content

2017-09-29T23:49:19Z

Replaced redirect with familiar content

Show changes

StDoodle: Redirected page to Data Types#familiar

2010-07-14T04:42:42Z

Redirected page to Data Types#familiar

← Older revision		Revision as of 04:42, 14 July 2010
Line 1:		Line 1:
	#REDIRECT [[~~Datatype Constants~~#familiar]]		#REDIRECT [[Data Types#familiar]]

StDoodle: Redirected page to Datatype Constants#familiar

2010-03-13T01:21:42Z

Redirected page to Datatype Constants#familiar

← Older revision		Revision as of 01:21, 13 March 2010
Line 1:		Line 1:
	~~This page has ASH functions and constants related to familiars.~~		#REDIRECT [[Datatype Constants#familiar]]

	~~== Basic Familiar Functions ==~~
	~~'''familiar [[my_familiar()]]''' - returns the familiar you currently have equipped.~~

	~~'''boolean [[have_familiar()\|have_familiar( familiar pet )]]''' - returns ''true'' if you have the specified familiar in your Terrarium (or "equipped"). Otherwise, returns ''false''.~~

	~~'''boolean [[use_familiar()\|use_familiar( familiar pet )]]''' - equips the specified familiar.~~

	~~'''int [[familiar_weight()\|familiar_weight( familiar pet )]]''' - returns the raw, unbuffed weight of the specified familiar.~~

	~~'''item~~ [[~~familiar_equipment()\|familiar_equipment( familiar pet )]]''' - returns the item that is most common to <tt>pet</tt>.~~


	== Datatype ~~Conversions ==~~
	~~'''string [[to_string()\|to_string( familiar pet )]]''' - returns the string name of <tt>pet</tt>.~~

	~~'''familiar [[to_familiar()\|to_familiar( string str )]]''' - returns <code>$~~familiar~~[str~~]~~</code> from the string given.~~

	~~'''int [[to_int()\|to_int( familiar pet )]]''' - returns the KoL number of familiar <tt>pet</tt> for raw URL building.~~

	~~'''familiar [[to_familiar()\|to_familiar( int nFamiliar )]]''' - returns <code>$familiar[pet]</code> from the KoL number of the familiar.~~


	~~== $familiar[constant~~] ==
	* Mosquito
	* Leprechaun
	* Levitating Potato
	* Angry Goat
	* Sabre-Toothed Lime
	* Fuzzy Dice
	* Spooky Pirate Skeleton
	* Barrrnacle
	* Howling Balloon Monkey
	* Stab Bat
	* Grue
	* Blood-Faced Volleyball
	* Ghuol Whelp
	* Baby Gravy Fairy
	* Cocoabo
	* Star Starfish
	* Hovering Sombrero
	* Ghost Pickle on a Stick
	* Killer Bee
	* Whirling Maple Leaf
	* Coffee Pixie
	* Cheshire Bat
	* Jill-O-Lantern
	* Hand Turkey
	* Crimbo Elf
	* Hanukkimbo Dreidl
	* Baby Yeti
	* Feather Boa Constrictor
	* Emo Squid
	* Personal Raincloud
	* Clockwork Grapefruit
	* MagiMechTech MicroMechaMech
	* Flaming Gravy Fairy
	* Frozen Gravy Fairy
	* Stinky Gravy Fairy
	* Spooky Gravy Fairy
	* Inflatable Dodecapede
	* Pygmy Bugbear Shaman
	* Doppelshifter
	* Attention-Deficit Demon
	* Cymbal-Playing Monkey
	* Temporal Riftlet
	* Sweet Nutcracker
	* Pet Rock
	* Snowy Owl
	* Teddy Bear
	* Ninja Pirate Zombie Robot
	* Sleazy Gravy Fairy
	* Wild Hare
	* Wind-up Chattering Teeth
	* Spirit Hobo
	* Astral Badger
	* Comma Chameleon
	* Misshapen Animal Skeleton
	* Scary Death Orb
	* Jitterbug
	* Nervous Tick
	* Reassembled Blackbird
	* Origami Towel Crane
	* Ninja Snowflake
	* Evil Teddy Bear
	* Toothsome Rock
	* Ancient Yuletide Troll
	* Dandy Lion
	* O.A.F.
	* Penguin Goodfella
	* Jumpsuited Hound Dog
	* Green Pixie
	* Ragamuffin Imp
	* Exotic Parrot
	* Wizard Action Figure
	* Gluttonous Green Ghost
	* Casagnova Gnome
	* Hunchbacked Minion
	* Crimbo P. R. E. S. S. I. E.
	* Bulky Buddy Box
	* Teddy Borg
	* RoboGoose
	* El Vibrato Megadrone
	* Mad Hatrack
	* Hobo Monkey
	* Llama Lama
	* Cotton Candy Carnie
	* Disembodied Hand
	* Black Cat
	* Uniclops
	* Psychedelic Bear
	* Baby Mutant Rattlesnake
	* Mutant Fire Ant
	* Mutant Cactus Bud
	* Mutant Gila Monster
	* Cuddlefish
	* Sugar Fruit Fairy
	* Imitation Crab
	* Pair of Ragged Claws
	* Magic Dragonfish

Zarqon: took out none's

2009-01-29T08:42:49Z

took out none's

← Older revision		Revision as of 08:42, 29 January 2009
Line 36:		Line 36:
	* Grue		* Grue
	* Blood-Faced Volleyball		* Blood-Faced Volleyball
	* none
	* Ghuol Whelp		* Ghuol Whelp
	* Baby Gravy Fairy		* Baby Gravy Fairy
Line 87:		Line 86:
	* Evil Teddy Bear		* Evil Teddy Bear
	* Toothsome Rock		* Toothsome Rock
	* none
	* Ancient Yuletide Troll		* Ancient Yuletide Troll
	* Dandy Lion		* Dandy Lion

Zarqon: oops, forgot a few

2009-01-29T08:42:09Z

oops, forgot a few

← Older revision		Revision as of 08:42, 29 January 2009
Line 106:		Line 106:
	* El Vibrato Megadrone		* El Vibrato Megadrone
	* Mad Hatrack		* Mad Hatrack
			* Hobo Monkey
			* Llama Lama
			* Cotton Candy Carnie
			* Disembodied Hand
			* Black Cat
			* Uniclops
			* Psychedelic Bear
			* Baby Mutant Rattlesnake
			* Mutant Fire Ant
			* Mutant Cactus Bud
			* Mutant Gila Monster
			* Cuddlefish
			* Sugar Fruit Fairy
			* Imitation Crab
			* Pair of Ragged Claws
			* Magic Dragonfish

Zarqon at 08:40, 29 January 2009

2009-01-29T08:40:50Z

← Older revision		Revision as of 08:40, 29 January 2009
Line 1:		Line 1:
	This page has ASH functions and constants related to familiars.		This page has ASH functions and constants related to familiars.

			== Basic Familiar Functions ==
	'''familiar [[my_familiar()]]''' - returns the familiar you currently have equipped.		'''familiar [[my_familiar()]]''' - returns the familiar you currently have equipped.

Zarqon at 08:39, 29 January 2009

2009-01-29T08:39:55Z

← Older revision		Revision as of 08:39, 29 January 2009
Line 1:		Line 1:
	This page has ASH functions and constants related to familiars.		This page has ASH functions and constants related to familiars.

	~~<code>~~'''familiar my_familiar()'''~~</code> <br />~~		'''familiar [[my_familiar()]]''' - returns the familiar you currently have equipped.
	~~Returns~~ the familiar you currently have equipped ~~as <code>$familiar[familiar]</code>~~.

	~~<code>~~'''boolean have_familiar( familiar pet )'''~~</code> <br />~~		'''boolean [[have_familiar()\|have_familiar( familiar pet )]]''' - returns ''true'' if you have the specified familiar in your Terrarium (or "equipped"). Otherwise, returns ''false''.
	~~Returns~~ true ~~or false depending on~~ if you have the familiar ~~<code>pet</code>~~ in your ~~terrarium~~ or equipped ~~on you~~.

	~~<code>~~'''boolean ~~equip_familiar~~( familiar pet )'''~~</code> <br />~~		'''boolean [[use_familiar()\|use_familiar( familiar pet )]]''' - equips the specified familiar.
	~~Returns true or false depending on if~~ the ~~<code>equip_familiar</code> succeeded in equipping the familiar <code>pet</code> as your current~~ familiar.

	~~<code>~~'''int familiar_weight( ~~familiar pet~~ )~~'''</code> <br />~~		'''int [[familiar_weight()\|familiar_weight( familiar pet )]]''' - returns the raw, unbuffed weight of the specified familiar.
	~~Returns the raw, unbuffed weight of the familiar <code>pet</code>.~~

	~~<code>'''int~~ familiar_weight( familiar pet )'''~~</code> <br />~~
	~~Returns the difference between~~ the unbuffed ~~and buffed weights of your currently equipped familiar.~~

	~~<code>'''boolean train_familiar( int nGoal, string sGoal )'''</code> <br />~~
	~~Trains your currently-equipped familiar. sGoal can be either “base”, “buffed”, or “turns”, and nGoal is either the target~~ weight ~~or desired number~~ of ~~battles. Returns success value.~~

	~~<code>'''item familiar_equipment( familiar pet )'''</code> <br />~~
	~~Returns~~ the ~~item that is most common to <code>pet</code>. e.g. This function will return <code>$item[Meat detector]</code> if pet is <code>$~~familiar~~[Leprechaun]</code>~~.

			'''item [[familiar_equipment()\|familiar_equipment( familiar pet )]]''' - returns the item that is most common to <tt>pet</tt>.


	== Datatype Conversions ==		== Datatype Conversions ==
	~~<code>~~'''string ~~familiar_to_string~~( familiar pet )'''~~</code> <br />~~		'''string [[to_string()\|to_string( familiar pet )]]''' - returns the string name of <tt>pet</tt>.
	~~Returns~~ the string name of <~~code~~>pet</~~code>.~~

	~~<code>'''familiar string_to_familiar( string str )'''</code~~> ~~<br />~~
	~~Returns <code>$familiar[str]</code> from the string given~~.

	~~<code>~~'''~~int familiar_to_int~~ ( ~~familiar pet~~ )'''</code> ~~<br />~~		'''familiar [[to_familiar()\|to_familiar( string str )]]''' - returns <code>$familiar[str]</code> from the string given.
	~~Returns the KoL number of~~ familiar ~~<code>pet~~</code> ~~for raw URL building~~.

	~~<code>~~'''familiar ~~int_to_familiar ( int nFamiliar~~ )'''<~~/code> <br />~~		'''int [[to_int()\|to_int( familiar pet )]]''' - returns the KoL number of familiar <tt>pet</tt> for raw URL building.
	~~Returns <code~~>~~$familiar[~~pet]</~~code~~> ~~from the KoL number of the familiar~~.

			'''familiar [[to_familiar()\|to_familiar( int nFamiliar )]]''' - returns <code>$familiar[pet]</code> from the KoL number of the familiar.

Zarqon: ran a foreach to list all familiars recognized by mafia 1/29/09; used wiki list formatting

2009-01-29T08:28:09Z

ran a foreach to list all familiars recognized by mafia 1/29/09; used wiki list formatting

← Older revision		Revision as of 08:28, 29 January 2009
Line 40:		Line 40:

	== $familiar[constant] ==		== $familiar[constant] ==
	* Angry Goat		* Mosquito
	* ~~Astral Badger~~		* Leprechaun
	* ~~Attention-Deficit Demon~~		* Levitating Potato
	* ~~Baby Gravy Fairy~~		* Angry Goat
	* ~~Baby Yeti~~		* Sabre-Toothed Lime
	* ~~Barrrnacle~~		* Fuzzy Dice
	* Blood-Faced Volleyball		* Spooky Pirate Skeleton
	* ~~Cheshire Bat~~		* Barrrnacle
	* ~~Clockwork Grapefruit~~		* Howling Balloon Monkey
	* Cocoabo		* Stab Bat
	* Coffee Pixie		* Grue
	* ~~Comma Chameleon~~		* Blood-Faced Volleyball
	* Crimbo Elf		* none
	* ~~Cymbal-Playing Monkey~~		* Ghuol Whelp
	* ~~Doppelshifter~~		* Baby Gravy Fairy
	* Emo Squid		* Cocoabo
	* ~~Feather Boa Constrictor~~		* Star Starfish
	* Flaming Gravy Fairy		* Hovering Sombrero
	* Frozen Gravy Fairy		* Ghost Pickle on a Stick
	* ~~Fuzzy Dice~~		* Killer Bee
	* ~~Ghost Pickle on a Stick~~		* Whirling Maple Leaf
	* ~~Ghuol Whelp~~		* Coffee Pixie
	* ~~Grue~~		* Cheshire Bat
	* ~~Hand Turkey~~		* Jill-O-Lantern
	* ~~Hanukkimbo Dreidl~~		* Hand Turkey
	* ~~Hovering Sombrero~~		* Crimbo Elf
	* ~~Howling Balloon Monkey~~		* Hanukkimbo Dreidl
	* ~~Inflatable Dodecapede~~		* Baby Yeti
	* ~~Jill~~-~~O-Lantern~~		* Feather Boa Constrictor
	* ~~Killer Bee~~		* Emo Squid
	* ~~Leprechaun~~		* Personal Raincloud
	* ~~Levitating Potato~~		* Clockwork Grapefruit
	* ~~MagiMechTech MicroMechaMech~~		* MagiMechTech MicroMechaMech
	* ~~Mosquito~~		* Flaming Gravy Fairy
	* Ninja ~~Pirate Zombie Robot~~		* Frozen Gravy Fairy
	* ~~Personal Raincloud~~		* Stinky Gravy Fairy
	* ~~Pet~~ Rock		* Spooky Gravy Fairy
	* ~~Pygmy Bugbear Shaman~~		* Inflatable Dodecapede
	* ~~Sabre-Toothed Lime~~		* Pygmy Bugbear Shaman
	* ~~Sleazy Gravy Fairy~~		* Doppelshifter
	* ~~Snowy Owl~~		* Attention-Deficit Demon
	* ~~Spirit Hobo~~		* Cymbal-Playing Monkey
	* ~~Spooky Gravy Fairy~~		* Temporal Riftlet
	* ~~Spooky Pirate Skeleton~~		* Sweet Nutcracker
	* ~~Stab Bat~~		* Pet Rock
	* ~~Star Starfish~~		* Snowy Owl
	* ~~Stinky Gravy Fairy~~		* Teddy Bear
	* ~~Sweet Nutcracker~~		* Ninja Pirate Zombie Robot
	* ~~Teddy Bear~~		* Sleazy Gravy Fairy
	* ~~Temporal Riftlet~~		* Wild Hare
	* ~~Whirling Maple Leaf~~		* Wind-up Chattering Teeth
	* ~~Wild Hare~~		* Spirit Hobo
	* ~~Wind-up Chattering Teeth~~		* Astral Badger
			* Comma Chameleon
			* Misshapen Animal Skeleton
			* Scary Death Orb
			* Jitterbug
			* Nervous Tick
			* Reassembled Blackbird
			* Origami Towel Crane
			* Ninja Snowflake
			* Evil Teddy Bear
			* Toothsome Rock
			* none
			* Ancient Yuletide Troll
			* Dandy Lion
			* O.A.F.
			* Penguin Goodfella
			* Jumpsuited Hound Dog
			* Green Pixie
			* Ragamuffin Imp
			* Exotic Parrot
			* Wizard Action Figure
			* Gluttonous Green Ghost
			* Casagnova Gnome
			* Hunchbacked Minion
			* Crimbo P. R. E. S. S. I. E.
			* Bulky Buddy Box
			* Teddy Borg
			* RoboGoose
			* El Vibrato Megadrone
			* Mad Hatrack

MagiNinjA: tune up of my pretty page ;)

2007-05-10T23:24:11Z

tune up of my pretty page ;)

← Older revision		Revision as of 23:24, 10 May 2007
Line 1:		Line 1:
	~~'''CURRENTLY A TEST PAGE~~.~~..MY BAD IF NO ONE LIKES IT. :)'''~~		This page has ASH functions and constants related to familiars.

	~~This will contain ASH functions and constants for familiars~~.		<code>'''familiar my_familiar()'''</code> <br />
			Returns the familiar you currently have equipped as <code>$familiar[familiar]</code>.

			<code>'''boolean have_familiar( familiar pet )'''</code> <br />
			Returns true or false depending on if you have the familiar <code>pet</code> in your terrarium or equipped on you.

	<code>familiar ~~my_familiar(~~)</code> <br />		<code>'''boolean equip_familiar( familiar pet )'''</code> <br />
	Returns the familiar ~~you currently have equipped as~~ <code>~~$familiar[familiar]~~</code>.		Returns true or false depending on if the <code>equip_familiar</code> succeeded in equipping the familiar <code>pet</code> as your current familiar.

	<code>int familiar_weight( familiar pet )</code> <br />		<code>'''int familiar_weight( familiar pet )'''</code> <br />
	Returns the raw, unbuffed weight of the familiar <code>pet</code>.		Returns the raw, unbuffed weight of the familiar <code>pet</code>.

	<code>int familiar_weight( familiar pet )</code> <br />		<code>'''int familiar_weight( familiar pet )'''</code> <br />
	Returns the difference between the unbuffed and buffed weights of your currently equipped familiar.		Returns the difference between the unbuffed and buffed weights of your currently equipped familiar.

	<code>boolean ~~have_familiar~~( ~~familiar pet~~ )</code> <br />		<code>'''boolean train_familiar( int nGoal, string sGoal )'''</code> <br />
	~~Returns true~~ or ~~false depending on if you have~~ the ~~familiar <code>pet</code> in your terrarium~~ or ~~equipped on you~~.		Trains your currently-equipped familiar. sGoal can be either “base”, “buffed”, or “turns”, and nGoal is either the target weight or desired number of battles. Returns success value.

	<code>~~boolean equip_familiar~~( familiar pet )</code> <br />		<code>'''item familiar_equipment( familiar pet )'''</code> <br />
	Returns ~~true or false depending on if~~ the <code>~~equip_familiar~~</code> ~~succeeded in equipping the familiar~~ <code>pet</code> ~~as your current familiar~~.		Returns the item that is most common to <code>pet</code>. e.g. This function will return <code>$item[Meat detector]</code> if pet is <code>$familiar[Leprechaun]</code>.

	~~<code>item familiar_equipment( familiar pet )</code> <br />~~
	~~Returns the item that is most common to <code>pet</code>. e.g. This function will return <code>$item[Meat detector]</code> if pet is <code>$familiar[Leprechaun]</code>.~~

	~~boolean train_familiar( int nGoal, string sGoal ) <br />~~
	~~Trains your currently-equipped familiar. sGoal can be either “base”, “buffed”, or “turns”, and nGoal is either the target weight or desired number of battles.~~

	== Datatype Conversions ==		== Datatype Conversions ==
	string familiar_to_string( familiar pet ) <br />		<code>'''string familiar_to_string( familiar pet )'''</code> <br />
	familiar string_to_familiar( string str ) <br />		Returns the string name of <code>pet</code>.
	int familiar_to_int ( familiar pet ) ~~# used for building raw URLs~~ <br />
	familiar int_to_familiar ( int nFamiliar ) ~~# converts an ASH object into a KoL number? not what we~~'~~re looking for, apparently.~~ <br />		<code>'''familiar string_to_familiar( string str )'''</code> <br />
			Returns <code>$familiar[str]</code> from the string given.

			<code>'''int familiar_to_int ( familiar pet )'''</code> <br />
			Returns the KoL number of familiar <code>pet</code> for raw URL building.

			<code>'''familiar int_to_familiar ( int nFamiliar )'''</code> <br />
			Returns <code>$familiar[pet]</code> from the KoL number of the familiar.



	== $familiar[constant] ==		== $familiar[constant] ==