|
|
Line 1: |
Line 1: |
| <!-- This file is auto generated, please don't edit manually! --> | | <!-- This file is auto generated, please don't edit manually! --> |
| = Animator = | | = Apps = |
| == Description == | | == Description == |
| Allows the user to set properties of a mission objects Unity animator
| | The Apps API allows modders to control Apps |
| The animator allows users to set key keyframe-able animations to control a large amount of components.
| |
| See [[https://docs.unity3d.com/Manual/class-Animator.html Unity's documentation]] for more details
| |
| == Functions == | | == Functions == |
| === SetBool === | | === RequestAppState === |
| <syntaxhighlight source lang="lua">Animator.SetBool(missionObjectName, parameterName, value)</syntaxhighlight> | | <syntaxhighlight source lang="lua">Apps.RequestAppState(appName, newState)</syntaxhighlight> |
| '''Expected parameter types''' | | '''Expected parameter types''' |
| {| class="wikitable" | | {| class="wikitable" |
Line 13: |
Line 11: |
| ! Name !! Type | | ! Name !! Type |
| |- | | |- |
| | missionObjectName || string | | | appName || string |
| |- | | |- |
| | parameterName || string | | | newState || OffGridApp+AppStates |
| |-
| |
| | value || bool
| |
| |}
| |
| '''Description''': Sets a bool parameter by name
| |
| | |
| '''Returns''': Nothing
| |
| | |
| === SetFloat ===
| |
| <syntaxhighlight source lang="lua">Animator.SetFloat(missionObjectName, parameterName, value)</syntaxhighlight>
| |
| '''Expected parameter types'''
| |
| {| class="wikitable"
| |
| |-
| |
| ! Name !! Type
| |
| |-
| |
| | missionObjectName || string
| |
| |-
| |
| | parameterName || string
| |
| |-
| |
| | value || number
| |
| |}
| |
| '''Description''': Sets a float parameter by name
| |
| | |
| '''Returns''': Nothing
| |
| | |
| === SetInt ===
| |
| <syntaxhighlight source lang="lua">Animator.SetInt(missionObjectName, parameterName, value)</syntaxhighlight>
| |
| '''Expected parameter types'''
| |
| {| class="wikitable"
| |
| |-
| |
| ! Name !! Type
| |
| |-
| |
| | missionObjectName || string
| |
| |-
| |
| | parameterName || string
| |
| |-
| |
| | value || number
| |
| |}
| |
| '''Description''': Sets a int parameter by name
| |
| | |
| '''Returns''': Nothing
| |
| | |
| === SetTrigger ===
| |
| <syntaxhighlight source lang="lua">Animator.SetTrigger(missionObjectName, parameterName)</syntaxhighlight>
| |
| '''Expected parameter types'''
| |
| {| class="wikitable"
| |
| |-
| |
| ! Name !! Type
| |
| |-
| |
| | missionObjectName || string
| |
| |-
| |
| | parameterName || string
| |
| |} | | |} |
| '''Description''': Begins a trigger parameter by name | | '''Description''': Ask an App to change it's state |
|
| |
|
| '''Returns''': Nothing | | '''Returns''': Nothing |
|
| |
| === GetBool ===
| |
| <syntaxhighlight source lang="lua">Animator.GetBool(missionObjectName, parameterName)</syntaxhighlight>
| |
| '''Expected parameter types'''
| |
| {| class="wikitable"
| |
| |-
| |
| ! Name !! Type
| |
| |-
| |
| | missionObjectName || string
| |
| |-
| |
| | parameterName || string
| |
| |}
| |
| '''Description''': Gets the current value of a bool parameter by name
| |
|
| |
| '''Returns''': The current bool value of the parameter
| |
|
| |
| === GetFloat ===
| |
| <syntaxhighlight source lang="lua">Animator.GetFloat(missionObjectName, parameterName)</syntaxhighlight>
| |
| '''Expected parameter types'''
| |
| {| class="wikitable"
| |
| |-
| |
| ! Name !! Type
| |
| |-
| |
| | missionObjectName || string
| |
| |-
| |
| | parameterName || string
| |
| |}
| |
| '''Description''': Gets the current value of a float parameter by name
| |
|
| |
| '''Returns''': The current float value of the parameter
| |
|
| |
| === GetInt ===
| |
| <syntaxhighlight source lang="lua">Animator.GetInt(missionObjectName, parameterName)</syntaxhighlight>
| |
| '''Expected parameter types'''
| |
| {| class="wikitable"
| |
| |-
| |
| ! Name !! Type
| |
| |-
| |
| | missionObjectName || string
| |
| |-
| |
| | parameterName || string
| |
| |}
| |
| '''Description''': Gets the current value of a int parameter by name
| |
|
| |
| '''Returns''': The current int value of the parameter
| |
|
| |
|
|
| |
|