Template:Lua global function returns/doc

About the Template

This template is used to define a range of variables providing infomation of the returns of a lua global function using Extension:Variables. These variables are used in Template:Lua global function signature and Template:Lua global function returns description. All variables except the function_name are optional.

Variables Definations

Paramater input	Variable name defined	Meaning
return_name_1	lgf_retn1	Psuedo-name of the 1st return value
return_name_2	lgf_retn2	Psuedo-name of the 2nd return value
return_name_3	lgf_retn3	Psuedo-name of the 3rd return value
return_name_4	lgf_retn4	Psuedo-name of the 4th return value
return_name_5	lgf_retn5	Psuedo-name of the 5th return value
return_name_6	lgf_retn6	Psuedo-name of the 6th return value
return_name_7	lgf_retn7	Psuedo-name of the 7th return value
return_name_8	lgf_retn8	Psuedo-name of the 8th return value
return_name_9	lgf_retn9	Psuedo-name of the 9th return value
return_name_10	lgf_retn0	Psuedo-name of the 10st return value
return_type_1	lgf_rett1	Type of the 1st return value
return_type_2	lgf_rett2	Type of the 2nd return value
return_type_3	lgf_rett3	Type of the 3rd return value
return_type_4	lgf_rett4	Type of the 4th return value
return_type_5	lgf_rett5	Type of the 5th return value
return_type_6	lgf_rett6	Type of the 6th return value
return_type_7	lgf_rett7	Type of the 7th return value
return_type_8	lgf_rett8	Type of the 8th return value
return_type_9	lgf_rett9	Type of the 9th return value
return_type_10	lgf_rett10	Type of the 10th return value

Those variables has a variation that have a suffix of _styled featuring monokai style.

Usage

{{Lua global function returns
| return_name_1 =
| return_name_2 =
| return_name_3 =
| return_name_4 =
| return_name_5 =
| return_name_6 =
| return_name_7 =
| return_name_8 =
| return_name_9 =
| return_name_10 =
| return_type_1 =
| return_type_2 =
| return_type_3 =
| return_type_4 =
| return_type_5 =
| return_type_6 =
| return_type_7 =
| return_type_8 =
| return_type_9 =
| return_type_10 =
}}

Example

Code:

number entityID = GetUpdatedEntityID()	

Template Usage:

{{Lua global function returns
| return_name_1 = entityID
| return_type_1 = number
}}

---

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.