Animator Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(adding the docStart tag)
No edit summary
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{OffGridDocStart}}
<!-- This file is auto generated, please don't edit manually! -->
= Animator =
= Animator =
== Description ==
== Description ==
Line 10: Line 10:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| missionObjectName || string
| missionObjectName || string
Line 25: Line 27:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| missionObjectName || string
| missionObjectName || string
Line 40: Line 44:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| missionObjectName || string
| missionObjectName || string
Line 55: Line 61:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| missionObjectName || string
| missionObjectName || string
Line 68: Line 76:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| missionObjectName || string
| missionObjectName || string
Line 81: Line 91:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| missionObjectName || string
| missionObjectName || string
Line 94: Line 106:
'''Expected parameter types'''
'''Expected parameter types'''
{| class="wikitable"
{| class="wikitable"
|-
! Name !! Type
|-
|-
| missionObjectName || string
| missionObjectName || string
Line 105: Line 119:




'''Docs last hacked together on''': 09/05/2017 12:04
This file is auto generated, please don't edit manually!
 
'''Docs last hacked together on''': 13/10/2021 15:55
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 09:08, 14 October 2021

Animator

Description

Allows the user to set properties of a mission objects Unity animator The animator allows users to set key keyframe-able animations to control a large amount of components. See [Unity's documentation] for more details

Functions

SetBool

Animator.SetBool(missionObjectName, parameterName, value)

Expected parameter types

Name Type
missionObjectName string
parameterName string
value bool

Description: Sets a bool parameter by name

Returns: Nothing

SetFloat

Animator.SetFloat(missionObjectName, parameterName, value)

Expected parameter types

Name Type
missionObjectName string
parameterName string
value number

Description: Sets a float parameter by name

Returns: Nothing

SetInt

Animator.SetInt(missionObjectName, parameterName, value)

Expected parameter types

Name Type
missionObjectName string
parameterName string
value number

Description: Sets a int parameter by name

Returns: Nothing

SetTrigger

Animator.SetTrigger(missionObjectName, parameterName)

Expected parameter types

Name Type
missionObjectName string
parameterName string

Description: Begins a trigger parameter by name

Returns: Nothing

GetBool

Animator.GetBool(missionObjectName, parameterName)

Expected parameter types

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

Animator.GetFloat(missionObjectName, parameterName)

Expected parameter types

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

Animator.GetInt(missionObjectName, parameterName)

Expected parameter types

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


This file is auto generated, please don't edit manually!

Docs last hacked together on: 13/10/2021 15:55