Kolmafia - User contributions [en]

Use familiar

2010-09-26T13:29:45Z

RogerMexico:

{{
#vardefine:name|use_familiar}}{{
#vardefine:return_type|boolean}}{{

FunctionPage|
name={{#var:name}}|

function1={{Function|
name={{#var:name}}|
aggregate={{#var:aggregate}}|
return_type={{#var:return_type}}|
return_also={{#var:return_also}}|
parameter1={{Param|familiar|buddy}}|
p1desc={{Pspan|buddy}} is the familiar to equip|
}}|

function_description=Switches your current familiar for the the familiar {{pspan|buddy}} specified. Returns true if the specified familiar {{pspan|buddy}} is your current familiar after the function's completion (so it will return true if you try to switch to your current familiar).|

needscode=yes|

code1={{CodeSample|
title=Code Sample|

code=<syntaxhighlight>
use_familiar( $familiar [Cocoabo]);
</syntaxhighlight>
}}|

see_also={{SeeAlso|have_familiar}}|
cli_equiv=The CLI command "familiar" has the same function when a familiar type is specified as the only parameter.|
}}

[[Category:Equipment]]

Talk:Use familiar

2010-09-26T13:26:17Z

RogerMexico:

This always seems to return false for me, can anyone confirm? 
--[[User:Slyz|Slyz]] 20:56, 9 April 2010 (UTC)

: > ash use_familiar($familiar[sandworm])

: Putting Mexicana the Hovering Sombrero back into terrarium... 
: Taking Hecho en Mexico the Baby Sandworm out of terrarium... 
: Returned: true 
I assume that the ash command should be enough to check return value; correct me if I'm wrong. --[[User:Heeheehee|Heeheehee]] 21:03, 9 April 2010 (UTC)

I'll have to recheck after RO, but here is what I was getting (doing things slightly differently):

: > ash print( use_familiar($familiar[slimeling]) )

: Putting Dusty the Baby Sandworm back into terrarium... 
: Taking Yuk the Slimeling out of terrarium... 
: false 
: Returned: void 
--[[User:Slyz|Slyz]] 03:33, 10 April 2010 (UTC)

Huh. Using that method, I get:
: > ash print( use_familiar($familiar[sombrero]) )

: Putting Hecho en Mexico the Baby Sandworm back into terrarium... 
: Taking Mexicana the Hovering Sombrero out of terrarium... 
: true 
: Returned: void
--[[User:Heeheehee|Heeheehee]] 07:51, 10 April 2010 (UTC)

I'm also seeing expected behavior; true most of the time, false if I try a familiar I don't have.
--[[User:StDoodle|StDoodle (#1059825)]] 14:52, 10 April 2010 (UTC)

I find the syntax as described on this page confusing. With other functions I do not have to specify the datatype, for example: 
outfit($string[Backup]); 
outfit("Backup"); 
both work identically. However, use_familiar("hobo"); 
returns the error "Function 'use_familiar( string )' undefined..." 
This just happened to be the first function I looked up on this wiki, and if the discussion with examples had not been here, I don't think I would have worked it out at all.--[[User:RogerMexico|RogerMexico]] 12:04, 25 September 2010 (UTC)

By default, supplying something inside of quotes is considered of the "string" datatype. So, $string[hello] is the same as "hello". However, use_familiar() needs the familiar datatype. You can't just supply a string (ie "hobo"); you need to supply a familiar. Since datatypes like familiar, element, etc. aren't "normal" datatypes used in programming, we have to use an explicit datatype constant call (the dollar-sign thing) or a function that converts from a string to that datatype. --[[User:StDoodle|StDoodle (#1059825)]] 18:42, 25 September 2010 (UTC)

I've done some further reading on this wiki (which is absolutely superb documentation by the way) and came to understand ''why'' it is that way. But for non-programmers like myself who are looking for a quick answer, I think an example on the page would help. I'll try adding one, hope I don't screw it up :) Oh, and is there a page that discusses syntax in general? The whole reason I went and looked at the outfit() function was to try and understand the syntax of the function (specifically, why is the word familiar inside the parentheses there?).The datatype page was helpful, I think something like that on syntax would be nice. --[[User:RogerMexico|RogerMexico]] 13:26, 26 September 2010 (UTC)

Talk:Use familiar

2010-09-25T12:04:01Z

RogerMexico: