Arma Reforger:Animation Editor: State Machine - Revision history

Lou Montana: Text replacement - "ized" to "ised"

2024-05-24T20:07:48Z

Text replacement - "ized" to "ised"

← Older revision		Revision as of 22:07, 24 May 2024
Line 31:		Line 31:
	This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State'''.		This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State'''.

	'''Normtime:''' The '''State''' keeps the time '''~~Normalized~~''', which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to.		'''Normtime:''' The '''State''' keeps the time '''Normalised''', which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to.
	\|-		\|-
	\| '''Start Condition'''		\| '''Start Condition'''
Line 286:		Line 286:
	\|		\|
	GetUpperNTime()		GetUpperNTime()
	\| Gets the ~~normalized~~ time from the upper node.		\| Gets the normalised time from the upper node.
	\|		\|
	\|		\|
Line 370:		Line 370:
	\|		\|
	LowerNTimePassed(float)		LowerNTimePassed(float)
	\| Returns true if the ~~normalized~~ time given by parameter has passed.		\| Returns true if the normalised time given by parameter has passed.
	\| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''		\| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''
	\| This function works only in post-eval!		\| This function works only in post-eval!
Line 432:		Line 432:
	\|		\|
	UpperNTimePassed(time)		UpperNTimePassed(time)
	\| Returns true if the ~~normalized~~ time coming from node above is greater than given argument.		\| Returns true if the normalised time coming from node above is greater than given argument.
	\|		\|
	\|		\|

Lou Montana: Text replacement - "`" to ""`


2023-01-11T10:53:19Z
Text replacement - "<code>" to "<code style="display: block">"

				
				
				
				
				
				← Older revision
				Revision as of 12:53, 11 January 2023
				
Line 394:
Line 394:
| |
  normalize(value, min, max)   normalize(value, min, max)
| Maps <code>value</code> from original range (<code>min-max</code>) to (<code>0</code>-<code>1</code>). Values outside are clamped. | Maps <code style="display: block">value</code> from original range (<code style="display: block">min-max</code>) to (<code style="display: block">0</code>-<code style="display: block">1</code>). Values outside are clamped.
| |
| Effectively it is the same as writing <code>clamp((x-from)/(to-from), 0, 1)</code>. | Effectively it is the same as writing <code style="display: block">clamp((x-from)/(to-from), 0, 1)</code>.
|- |-
| |



Lou Montana: Some wiki formatting
2022-09-15T21:42:56Z
Some wiki formatting

				
				
				
				
				
				← Older revision
				Revision as of 23:42, 15 September 2022
				
Line 19:
Line 19:
|- |-
| '''Link''' | '''Link'''
| Every '''State''' has a '''Link''' that it connects to something in a graph, such as a '''Source Node, Blend Node,''' or another '''State Machine'''. | Every '''State''' has a '''Link''' that it connects to something in a graph, such as a '''Source Node, Blend Node''', or another '''State Machine'''.



A node outside of the '''State Machine''' cannot link directly to a '''State''' inside of the machine, only to the '''State Machine''' itself. A node outside of the '''State Machine''' cannot link directly to a '''State''' inside of the machine, only to the '''State Machine''' itself.
Line 31:
Line 31:
This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State'''. This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State'''.



'''Normtime:''' The '''State''' keeps the time '''Normalized,''' which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to. '''Normtime:''' The '''State''' keeps the time '''Normalized''', which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to.
|- |-
| '''Start Condition''' | '''Start Condition'''
| When the parent '''State Machine''' of the '''State''' is first reached, the '''Start Condition''' of each '''State''' is evaluated, and depending on which one is true, that one will be the starting '''State'''. If '''none is true,''' the '''first''' node that was created in that '''State Machine will be chosen'''. This should be avoided when possible, as it could lead to unwanted final results. | When the parent '''State Machine''' of the '''State''' is first reached, the '''Start Condition''' of each '''State''' is evaluated, and depending on which one is true, that one will be the starting '''State'''. If '''none is true''', the '''first''' node that was created in that '''State Machine will be chosen'''. This should be avoided when possible, as it could lead to unwanted final results.
|- |-
| '''Exit''' | '''Exit'''
Line 78:
Line 78:
| Using this will make the node the transition is blending to start at this time. Can be used to send time from one state to another. See '''Functions and Conditions'''. | Using this will make the node the transition is blending to start at this time. Can be used to send time from one state to another. See '''Functions and Conditions'''.
|- |-
| colspan="1" |'''Blend Fn''' | '''Blend Fn'''
| colspan="1" |Lin - Linear | Lin - Linear



SStart - Curve in then linear SStart - Curve in then linear
Line 133:
Line 133:
| && | &&
| And | And
| (float_1 > float_2 && boolean), if float_1 is greater than float_2, '''AND''' boolean is '''true''', return '''true.''' If '''any''' of part of the operation is '''false,''' return '''false.'''   | (float_1 > float_2 && boolean), if float_1 is greater than float_2, '''AND''' boolean is '''true''', return '''true'''. If '''any''' of part of the operation is '''false''', return '''false.'''
|- |-
| <nowiki>||</nowiki> | <nowiki>||</nowiki>
| Or | Or
| <nowiki>(integer_1 <= integer_2 || boolean), if integer_1 is lesser or equal than integer_2, </nowiki>'''OR''' boolean is '''true''', if '''any''' of part of the operation is '''true,''' return '''true'''. If all parts of the operation is '''false,''' return '''false.''' | <nowiki>(integer_1 <= integer_2 || boolean), if integer_1 is lesser or equal than integer_2, </nowiki>'''OR''' boolean is '''true''', if '''any''' of part of the operation is '''true''', return '''true'''. If all parts of the operation is '''false''', return '''false.'''
|} |}



Line 152:
Line 152:
1 - Walk 1 - Walk



2 - Run   2 - Run



3 - Sprint   3 - Sprint
|- |-
| Stance | Stance
Line 160:
Line 160:
| 0 - Stand | 0 - Stand
1 - Crouch 1 - Crouch
2 - Prone   2 - Prone
|- |-
| Aiming | Aiming
Line 166:
Line 166:
| True - Aiming | True - Aiming



False - Not aiming   False - Not aiming
|} |}
If the character is either running or sprinting and he is standing up, return true. If the character is either running or sprinting and he is standing up, return true.



'''MovementSpeed >= 2 && Stance == 0'''   '''MovementSpeed >= 2 && Stance == 0'''



If the character is currently not moving and not prone, return true. If the character is currently not moving and not prone, return true.
Line 252:
Line 252:
| returns float time of the event time in animation | returns float time of the event time in animation
| |
| usage -> starttime expression in transition   | usage -> starttime expression in transition



GetEventTime("ladder.enterOn", "LegUp")   GetEventTime("ladder.enterOn", "LegUp")



starts new state where the event "LegUp" is in animation of entering ladder   starts new state where the event "LegUp" is in animation of entering ladder



This function works only in post-eval! This function works only in post-eval!
Line 270:
Line 270:
| Returns the time of the previous state | Returns the time of the previous state
| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.''' | If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''
| Used when transitioning from one animation to another, and the time of those two animations needs to line up. An example would be when '''Syncing Animations,''' and you need to pass the time from one '''State''' to another. | Used when transitioning from one animation to another, and the time of those two animations needs to line up. An example would be when '''Syncing Animations''', and you need to pass the time from one '''State''' to another.
|- |-
| |
Line 420:
Line 420:
| Returns true when the remaining animation time in child node is lesser than the float given | Returns true when the remaining animation time in child node is lesser than the float given
| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.''' | If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''
| If used in a '''Transition,''' it will transition if the remaining time is less than the float given | If used in a '''Transition''', it will transition if the remaining time is less than the float given



This function works only in post-eval! This function works only in post-eval!



Lou Montana: Add Statements (Operators & Functions)
2022-06-02T16:02:42Z
Add Statements (Operators & Functions)
Show changes


Lou Montana: Add Transitions
2022-06-02T15:12:57Z
Add Transitions

				
				
				
				
				
				← Older revision
				Revision as of 17:12, 2 June 2022
				
Line 28:
Line 28:



'''Realtime:''' The '''State''' keeps time, and the time is incrementing as normal time. '''Realtime:''' The '''State''' keeps time, and the time is incrementing as normal time.
This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State.''' This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State'''.



'''Normtime:''' The '''State''' keeps the time '''Normalized,''' which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to. '''Normtime:''' The '''State''' keeps the time '''Normalized,''' which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to.
|- |-
|'''Start Condition''' |'''Start Condition'''
|When the parent '''State Machine''' of the '''State''' is first reached, the '''Start Condition''' of each '''State''' is evaluated, and depending on which one is true, that one will be the starting '''State'''. If '''none is true,''' the '''first''' node that was created in that '''State Machine will be chosen.''' This should be avoided when possible, as it could lead to unwanted final results. |When the parent '''State Machine''' of the '''State''' is first reached, the '''Start Condition''' of each '''State''' is evaluated, and depending on which one is true, that one will be the starting '''State'''. If '''none is true,''' the '''first''' node that was created in that '''State Machine will be chosen'''. This should be avoided when possible, as it could lead to unwanted final results.
|- |-
| '''Exit''' | '''Exit'''
| When this is checked, any time that this node has will be passed up to the '''State Machine''' above, assuming there is one. | When this is checked, any time that this node has will be passed up to the '''State Machine''' above, assuming there is one.
This is explained in depth inside of the '''Transitions''' article. This is explained in depth inside of the '''Transitions''' article.
|}


== Transition ==

Transitions are needed to go between between '''States''' inside of '''State Machines'''.

To create a transition, right click on a '''State''' and click '''Insert Transition''' and then click on the next '''State''' to create the transition between them.

All transitions have these properties:
{| class="wikitable"
! Property
! Description
|-
| '''From'''
| The node that the transition will go from
|-
| '''To'''
| The node that the transition will go to
|-
| '''Condition'''
| On the condition that the transition will execute upon. Read the '''Functions and Conditions''' article for further information on what syntax it uses.
|-
| '''Post Eval'''
| Tick to enable. If the transition is using time to evaluate within its condition statement or while send time through its start time, this '''needs to be ticked''' ('''VERY IMPORTANT''').
Read more on this in '''Functions and Conditions'''.

This is because the transition needs to keep the data even after the tick has finished evaluating.
|-
| '''Duration'''
| The blend duration of the transition.

'''Note:''' Has to be decimals, eg. 0.3, 1.0, or 0.0.

If 0 or 1 are typed then they become an integer, and an error will appear.
|-
| '''Start Time'''
| Using this will make the node the transition is blending to start at this time. Can be used to send time from one state to another. See '''Functions and Conditions'''.
|-
| colspan="1" |'''Blend Fn'''
| colspan="1" |Lin - Linear

SStart - Curve in then linear

SEnd - Linear then curve out

S - Blend in blend out

S2 - Similar to blend in and blend out, but with a dip down at the start and a dip up near the end
|} |}






{{GameCategory|armaR|Modding|Official Tools}} {{GameCategory|armaR|Modding|Official Tools}}



Lou Montana: Page creation
2022-06-02T14:01:26Z
Page creation
New page
This article explains the concepts of a state machine and how they can be used in animation graphs.





== State Machine ==



A '''State Machine''' is a basic functionality in any graph, and it is what decides what the animated object is currently doing, whether that is moving, idling, eating, eating while moving, and so on.

A character can be in multiple '''States''' at once, but generally stays in one at a time.





== State ==



A '''State''' is a child of the '''State Machine'''. It can be named anything and it will not conflict with the rest of the graph, as long as the name is unique inside its '''State Machine'''.



Each '''State''' has its own set of properties:

{| class="wikitable"

! State

! Description

|-

| '''Link'''

| Every '''State''' has a '''Link''' that it connects to something in a graph, such as a '''Source Node, Blend Node,''' or another '''State Machine'''.



A node outside of the '''State Machine''' cannot link directly to a '''State''' inside of the machine, only to the '''State Machine''' itself.

|-

| '''Time'''

| Each '''State''' handles its own time inside of its '''Time''' property and it has three options.



'''Notime:''' The '''State''' does not keep any time, or use any time. Used when the '''State''' is linking to another '''State Machine''' that handles its own time.



'''Realtime:''' The '''State''' keeps time, and the time is incrementing as normal time.

This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State.'''



'''Normtime:''' The '''State''' keeps the time '''Normalized,''' which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to.

|-

|'''Start Condition'''

|When the parent '''State Machine''' of the '''State''' is first reached, the '''Start Condition''' of each '''State''' is evaluated, and depending on which one is true, that one will be the starting '''State'''. If '''none is true,''' the '''first''' node that was created in that '''State Machine will be chosen.''' This should be avoided when possible, as it could lead to unwanted final results.

|-

| '''Exit'''

| When this is checked, any time that this node has will be passed up to the '''State Machine''' above, assuming there is one.

This is explained in depth inside of the '''Transitions''' article.

|}





{{GameCategory|armaR|Modding|Official Tools}}

← Older revision		Revision as of 12:53, 11 January 2023
Line 394:		Line 394:
	\|		\|
	normalize(value, min, max)		normalize(value, min, max)
	\| Maps <code>value</code> from original range (<code>min-max</code>) to (<code>0</code>-<code>1</code>). Values outside are clamped.		\| Maps <code style="display: block">value</code> from original range (<code style="display: block">min-max</code>) to (<code style="display: block">0</code>-<code style="display: block">1</code>). Values outside are clamped.
	\|		\|
	\| Effectively it is the same as writing <code>clamp((x-from)/(to-from), 0, 1)</code>.		\| Effectively it is the same as writing <code style="display: block">clamp((x-from)/(to-from), 0, 1)</code>.
	\|-		\|-
	\|		\|

← Older revision		Revision as of 23:42, 15 September 2022
Line 19:		Line 19:
	\|-		\|-
	\| '''Link'''		\| '''Link'''
	\| Every '''State''' has a '''Link''' that it connects to something in a graph, such as a '''Source Node, Blend Node,''' or another '''State Machine'''.		\| Every '''State''' has a '''Link''' that it connects to something in a graph, such as a '''Source Node, Blend Node''', or another '''State Machine'''.

	A node outside of the '''State Machine''' cannot link directly to a '''State''' inside of the machine, only to the '''State Machine''' itself.		A node outside of the '''State Machine''' cannot link directly to a '''State''' inside of the machine, only to the '''State Machine''' itself.
Line 31:		Line 31:
	This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State'''.		This is used primarily when the '''State''' is linking directly to an animation that needs to loop or transition out of the '''State'''.

	'''Normtime:''' The '''State''' keeps the time '''Normalized,''' which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to.		'''Normtime:''' The '''State''' keeps the time '''Normalized''', which means that time inside of the state is going to be uniform and if passed to another node (described how to later) it is going to be the same for each node that it passes to.
	\|-		\|-
	\| '''Start Condition'''		\| '''Start Condition'''
	\| When the parent '''State Machine''' of the '''State''' is first reached, the '''Start Condition''' of each '''State''' is evaluated, and depending on which one is true, that one will be the starting '''State'''. If '''none is true,''' the '''first''' node that was created in that '''State Machine will be chosen'''. This should be avoided when possible, as it could lead to unwanted final results.		\| When the parent '''State Machine''' of the '''State''' is first reached, the '''Start Condition''' of each '''State''' is evaluated, and depending on which one is true, that one will be the starting '''State'''. If '''none is true''', the '''first''' node that was created in that '''State Machine will be chosen'''. This should be avoided when possible, as it could lead to unwanted final results.
	\|-		\|-
	\| '''Exit'''		\| '''Exit'''
Line 78:		Line 78:
	\| Using this will make the node the transition is blending to start at this time. Can be used to send time from one state to another. See '''Functions and Conditions'''.		\| Using this will make the node the transition is blending to start at this time. Can be used to send time from one state to another. See '''Functions and Conditions'''.
	\|-		\|-
	~~\| colspan="1"~~ \|'''Blend Fn'''		\| '''Blend Fn'''
	~~\| colspan="1"~~ \|Lin - Linear		\| Lin - Linear

	SStart - Curve in then linear		SStart - Curve in then linear
Line 133:		Line 133:
	\| &&		\| &&
	\| And		\| And
	\| (float_1 > float_2 && boolean), if float_1 is greater than float_2, '''AND''' boolean is '''true''', return '''true.''' If '''any''' of part of the operation is '''false,''' return '''false.'''		\| (float_1 > float_2 && boolean), if float_1 is greater than float_2, '''AND''' boolean is '''true''', return '''true'''. If '''any''' of part of the operation is '''false''', return '''false.'''
	\|-		\|-
	\| <nowiki>\|\|</nowiki>		\| <nowiki>\|\|</nowiki>
	\| Or		\| Or
	\| <nowiki>(integer_1 <= integer_2 \|\| boolean), if integer_1 is lesser or equal than integer_2, </nowiki>'''OR''' boolean is '''true''', if '''any''' of part of the operation is '''true,''' return '''true'''. If all parts of the operation is '''false,''' return '''false.'''		\| <nowiki>(integer_1 <= integer_2 \|\| boolean), if integer_1 is lesser or equal than integer_2, </nowiki>'''OR''' boolean is '''true''', if '''any''' of part of the operation is '''true''', return '''true'''. If all parts of the operation is '''false''', return '''false.'''
	\|}		\|}

Line 152:		Line 152:
	1 - Walk		1 - Walk

	2 - Run		2 - Run

	3 - Sprint		3 - Sprint
	\|-		\|-
	\| Stance		\| Stance
Line 160:		Line 160:
	\| 0 - Stand		\| 0 - Stand
	1 - Crouch		1 - Crouch
	2 - Prone		2 - Prone
	\|-		\|-
	\| Aiming		\| Aiming
Line 166:		Line 166:
	\| True - Aiming		\| True - Aiming

	False - Not aiming		False - Not aiming
	\|}		\|}
	If the character is either running or sprinting and he is standing up, return true.		If the character is either running or sprinting and he is standing up, return true.

	'''MovementSpeed >= 2 && Stance == 0'''		'''MovementSpeed >= 2 && Stance == 0'''

	If the character is currently not moving and not prone, return true.		If the character is currently not moving and not prone, return true.
Line 252:		Line 252:
	\| returns float time of the event time in animation		\| returns float time of the event time in animation
	\|		\|
	\| usage -> starttime expression in transition		\| usage -> starttime expression in transition

	GetEventTime("ladder.enterOn", "LegUp")		GetEventTime("ladder.enterOn", "LegUp")

	starts new state where the event "LegUp" is in animation of entering ladder		starts new state where the event "LegUp" is in animation of entering ladder

	This function works only in post-eval!		This function works only in post-eval!
Line 270:		Line 270:
	\| Returns the time of the previous state		\| Returns the time of the previous state
	\| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''		\| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''
	\| Used when transitioning from one animation to another, and the time of those two animations needs to line up. An example would be when '''Syncing Animations,''' and you need to pass the time from one '''State''' to another.		\| Used when transitioning from one animation to another, and the time of those two animations needs to line up. An example would be when '''Syncing Animations''', and you need to pass the time from one '''State''' to another.
	\|-		\|-
	\|		\|
Line 420:		Line 420:
	\| Returns true when the remaining animation time in child node is lesser than the float given		\| Returns true when the remaining animation time in child node is lesser than the float given
	\| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''		\| If used in transition, enable '''Post Eval'''. Read more on '''Transitions.'''
	\| If used in a '''Transition,''' it will transition if the remaining time is less than the float given		\| If used in a '''Transition''', it will transition if the remaining time is less than the float given

	This function works only in post-eval!		This function works only in post-eval!

Arma Reforger:Animation Editor: State Machine - Revision history

Lou Montana: Text replacement - "ized" to "ised"

Lou Montana: Text replacement - "" to ""

Lou Montana: Some wiki formatting

Lou Montana: Add Statements (Operators & Functions)

Lou Montana: Add Transitions

Lou Montana: Page creation

Lou Montana: Text replacement - "`" to ""`