User:Draugath

I'm going to be working on a series of Templates for easing the creation of function entries and producing identical results across all function entries.

Template:Function

This template will be the top-level wrapper template that handles input and passing of information.
Template:Function

Template:Function_wrapped

This template will initially be the one that provides the final output. More templates may be created later.
Template:Function_wrapped

Example

{{Function
| name         =FunctionName
| desc         =Function description
| arg1_name    =arg1
| arg1_type    =number
| arg1_desc    =argument (1,2,...,n) description, including examples if so desired
| arg2_name    =arg2
| arg2_type    =string
| arg2_desc    =argument (1,2,...,n) description, including examples if so desired
| arg3_name    =arg3
| arg3_type    =string
| arg3_desc    =argument (1,2,...,n) description, including examples if so desired
| arg3_opt     =true
| ret1_name    =ret1
| ret1_type    =string
| ret1_desc    =return value (1,2,...,n) description, including examples if so desired
| ret2_name    =ret2
| ret2_type    =table
| ret2_desc    =return value (1,2,...,n) description, including examples if so desired
| notes        =notes
}}

FunctionName

Definition

FunctionName( number  arg1,  string  arg2,  test1, number, , test2, string, , , , , , , , , , , , , , , , , , , , , , [,  string  arg4 ]) ->  string  ret1,  table  ret2

Description

Function description

Arguments

Type	Name	Description
number	arg1	argument (1,2,...,n) description, including examples if so desired
string	arg2	argument (1,2,...,n) description, including examples if so desired
	test1, number, , test2, string, , , , , , , , , , , , , , , , , , , , , ,
string	arg4	argument (1,2,...,n) description, including examples if so desired (optional)

Returns

Type	Name	Description
string	ret1	return value (1,2,...,n) description, including examples if so desired
table	ret2	return value (1,2,...,n) description, including examples if so desired

Notes

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mauris lorem, scelerisque sed facilisis ut, mattis ut dui. In vestibulum porttitor dolor et scelerisque. Quisque dolor ante, ullamcorper vitae posuere ut, ornare rutrum lacus. Vestibulum eget luctus mi. Cras et interdum augue. Vivamus erat lorem, aliquet tristique hendrerit a, eleifend nec ante. Maecenas volutpat mattis dui ac cursus. Nunc in turpis augue, eget pharetra arcu. Nulla porta laoreet erat sit amet semper. Fusce dignissim sodales accumsan. Cras nisl sem, imperdiet quis convallis vel, feugiat a massa. Cras venenatis tristique odio, et faucibus ligula adipiscing eget. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec mauris lorem, scelerisque sed facilisis ut, mattis ut dui. In vestibulum porttitor dolor et scelerisque. Quisque dolor ante, ullamcorper vitae posuere ut, ornare rutrum lacus. Vestibulum eget luctus mi. Cras et interdum augue. Vivamus erat lorem, aliquet tristique hendrerit a, eleifend nec ante. Maecenas volutpat mattis dui ac cursus. Nunc in turpis augue, eget pharetra arcu. Nulla porta laoreet erat sit amet semper. Fusce dignissim sodales accumsan. Cras nisl sem, imperdiet quis convallis vel, feugiat a massa. Cras venenatis tristique odio, et faucibus ligula adipiscing eget.

{{Function
| name       = GetTargetInfo
| desc       = get info about target
| ret1_name  = name
| ret1_type  = string
| ret1_desc  =
| ret2_name  = health
| ret2_type  = number
| ret2_desc  = health in percent
| ret3_name  = dist
| ret3_type  = number
| ret3_desc  = distance in m
| ret4_name  = factionid
| ret4_type  = number
| ret4_desc  = faction of target
| ret5_name  = guild
| ret5_type  = string
| ret5_desc  = guild tag of target
| ret6_name  = ship
| ret6_type  = string
| ret6_desc  = name of targets ship
}}

GetTargetInfo

Definition

GetTargetInfo() ->  name,  number  health,  number,  number  factionid,  string  guild,  string  ship

Description

get info about target

Returns

Type	Name	Description
	name
number	health	health in percent
number		distance in m
number	factionid	faction of target
string	guild	guild tag of target
string	ship	name of targets ship