Template talk:FunctionArgument

From GECK

Default Value

Certain optional parameters, such as the [FadeIn] parameter of Enable and Disable, have a default value which is used if the parameter is absent. At the moment, this template has no way in which this information can be included. Although I'm not familiar with editing Wiki templates, I'm sure that I could figure it out easily enough. However, I'm not sure exactly how this information should be included in the template, particularly if it is to be included alongside a specific set of available values. Does anyone have any suggestions?
-- Cipscis 04:37, 15 May 2009 (UTC)

I'm pretty sure that you could include it in the Values section, so like this:
Values = 0,1;Default=0
Or something. I think it'll work.
DragoonWraith · talk · 04:46, 15 May 2009 (UTC)
Sounds like a good idea. I'll edit one of the examples on the template page so that others know to do the same. Thanks
-- Cipscis 06:10, 15 May 2009 (UTC)

Deprecated parameters

Some functions used in both Fallout 3 and Oblivion have parameters that are still accepted by the compiler but have no effect, such as PlaceAtMe's Distance and Direction parameters. At the moment the only ways to mention this are to omit the parameters, or add a note to the page mentioning that they have no effect.

User:Hugepinball has brought up the idea of a "deprecated" flag for this template in order to convey this information, and I think it would be a good idea, but I'm not sure how it should be included in the template. Does anyone have any preferences about this?
-- Cipscis 01:30, 4 March 2010 (UTC)

Type

In the function template, do you put "ref" under "Type" regardless of whether it's a Form/Base or an actual Reference?

|arguments = 
  {{FunctionArgument
   |Name = ActorRefID
   |Type = ref
  }}
  
 |arguments = 
  {{FunctionArgument
   |Name = ActorFormID/ActorBaseID
   |Type = ref? form? base?
  }}


--Ez0n3 15:56, 14 January 2011 (UTC)

If I remember it correctly it's the type of the variable you can store the argument in. Reference IDs, and Base IDs can both be stored in ref variables.
Qazaaq 11:20, 16 January 2011 (UTC)

Optional arguments

When a value is optional, and I put the "|Optional = y" param, there doesn't seem to be any indication other than viewing the source that it's optional. Some entries not using the function template have the word (optional) after a value. When I set it up to use the template, I have been doing:

|arguments = 
  {{FunctionArgument
   |Name = Count
   |Type = int
   |Value = 1 (optional)
  }}

That doesn't seem right, is that, or is there, a "proper" way?
--Ez0n3 15:56, 14 January 2011 (UTC)

All optional arguments are set in italics. Apparently this isn't as obvious as we thought it would be, as you didn't notice this. Any suggestions are welcome. Bold seems wrong, but maybe we could put optional arguments between < and >.
--Qazaaq 11:20, 16 January 2011 (UTC)
Personal tools