Grimes at 22:02, 8 October 2020

2020-10-08T22:02:16Z

Grimes at 22:01, 8 October 2020

2020-10-08T22:01:42Z

Grimes: 1 revision imported

2018-04-12T00:12:12Z

1 revision imported

New page

This is a guide to explain to a minor extent how functions work, but this guide is mostly focused on how the scripting documentation on this wiki is organized.

=== Guide Format ===
This guide utilizes a color coded breakdown of different parts of each function.

ReturnedValueType, … '''functionName(''' '''RequiredVariableType''' ''RequiredVariableName'', … , '''OptionalVariableType''' ''OptionalVariableName'', … ''')'''

{|class="wikitable" width="1400"
|width="350"|Return Variable Type
|width="350"|Name of Function
|width="350" colspan="2"|Required Input Variables
|width="350" colspan="2"|Optional Input Variables
|-
|width="350"|ReturnedValueType, …
|width="350"|'''functionName()'''
|width="350" colspan="2"|'''RequiredVariableType''' ''RequiredVariableName'', … 
|width="350" colspan="2"|'''OptionalVariableType''' ''OptionalVariableName'', … 
|-
|width="350"|This is the [http://lua-users.org/wiki/LuaTypesTutorial value type] that is returned when the function is run. The return variable is always colored in ORANGE Typical values are:
boolean (true/false)
table
string
number
nothing (literally nothing is returned)

|width="350"|This is the name of the scripting function. It is case sensitive.

|width="350" colspan="2"|Required input variables are defined as the bare minimum variables needed for the function to work correctly. All required variables are colored in BLUE

|width="350" colspan="2"|Optional input variables are listed after the required variables and are colored in GREEN. Most functions should be programmed so that not all optional values are required. Optional values that are not needed should simply be listed as nil. For example [[GroupRandomDistSelf|mist.groupRandomDistSelf]]
mist.groupRandomDistSelf('myGroup2', 6000, nil, 270)
|-
|width="700" colspan="2"|
|width="175"|'''Required variable type name in bold'''
|width="175"|''description of what it is used for in italics''
|width="175"|'''Required variable type name in bold'''
|width="175"|''description of what it is used for in italics''
|}

The order of the values must remain the same. Think of each function as the following:
myFunction(inputValue1, inputValue2, inputValue3, inputValue4, etc)

The minimum number of variables is dependent on the number of required variables. For example [[groupToPoint|mist.groupToPoint]] has 2 required variables and 4 optional variables. The following are each a valid function call.

mist.groupToPoint('myGroup', 'myZone')
mist.groupToPoint('myGroup', 'myZone', nil, 35, 30)
mist.groupToPoint('myGroup', 'myZone', 'cone', nil, nil, true)
mist.groupToPoint('myGroup', 'myZone', nil, nil, nil, true)

==== Table Input Variables ====
Input values that are tables have their own requirements. A table is similar to the above variables, however each table entry has a specific name instead of following a specific order.

=== Function Page Guide ===
Each function page will look something like this.

{{Mission Scripting

|fName= functionName

|vNum = Version of game or Custom Script in which the this function was added.

|desc= A short description of what the function does

|rtnType= ReturnedValueType, …

|reqType1= RequiredVariableDataType

|reqName1= RequiredVariableName

|reqType2= type

|reqName2= name

|reqType3=

|optType1= OptionalVariableType

|optName1= OptionalVariableName

|optType2=

|varExamples= In this space is a description of each variable and what it does. This section is not color coded. Typically it will look like this:

RequiredVariableName1 = 'myGroup' (an actual example)

or

RequiredVariableName1 = string of groupName (description of what the value should be)

If the variables are a table there is usually a description or example of what should be in the table. If a generic table name of "vars" is used this section will usually be accompanied by the following data:

{{varsTable

|r1T= reqDataType1
|r1N= reqTableEntryName1

|r2T= reqDataType2
|r2N= reqTableEntryName2

|r3T= reqDataType3
|r3N= reqTableEntryName3

|r4T=
|r4N=

|r5T=
|r5N=

|r6T=
|r6N=

|o1T= optionalDataType1
|o1N= optionalTableEntryName1

|o2T= optionalDataType2
|o2N= optionalTableEntryName2

|o3T=
|o3N=

|o4T=
|o4N=

|o5T=
|o5N=

|r1D= short description of what this entry needs to be
|r2D= short description of what this entry needs to be
|r3D= short description of what this entry needs to be
|r4D=
|r5D=
|r6D=

|o1D= short description of what this entry needs to be
|o2D= short description of what this entry needs to be
|o3D=
|o4D=
|o5D=
}}

|rtnExamples= Simple example of what is returned.

|example= <code>
Coding example of how to use the script for a practical but simple implementation
do
local myValue = myFunction('reqVariable1', ReqVars, 'optionalValue2')
end
</code>

|notes= Assorted notes will go into this section. Generally anything about how the function might have changed from one version to another. Also present in this section could be a list of other functions that this function will utilize.

|funcs= Links to related functions will be here. Generally listed by approximate category or object class functions.

}}

[[Category: Scripting]]

@@ Line 28: / Line 28: @@
 |width="350" colspan="2"|Required input variables are defined as the bare minimum variables needed for the function to work correctly. All required variables are colored in <span style="color:blue">BLUE</span>
-|width="350" colspan="2"|Optional input variables are listed after the required variables and are colored in <span style="color:green">GREEN</span>. Most functions should be programmed so that not all optional values are required. Optional values that are not needed should simply be listed as nil. For example [[GroupRandomDistSelf|mist.groupRandomDistSelf]]
+|width="350" colspan="2"|Optional input variables are listed after the required variables and are colored in <span style="color:green">GREEN</span>. Most functions should be programmed so that not all optional values are required. Optional values that are not needed should simply be listed as nil. For example [[MIST_groupRandomDistSelf|mist.groupRandomDistSelf]]
   mist.groupRandomDistSelf('myGroup2', 6000, nil, 270)
 |-

← Older revision		Revision as of 22:01, 8 October 2020
Line 42:		Line 42:


−	The minimum number of variables is dependent on the number of required variables. For example [[~~groupToPoint~~\|mist.groupToPoint]] has 2 required variables and 4 optional variables. The following are each a valid function call.	+	The minimum number of variables is dependent on the number of required variables. For example [[MIST_groupToPoint\|mist.groupToPoint]] has 2 required variables and 4 optional variables. The following are each a valid function call.

	mist.groupToPoint('myGroup', 'myZone')		mist.groupToPoint('myGroup', 'myZone')

Scripting Documentation Guide - Revision history

Grimes at 22:02, 8 October 2020

Grimes at 22:01, 8 October 2020

Grimes: 1 revision imported