Arma Reforger:Procedural Animation Editor Basics Tutorial - Revision history

Lou Montana: Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

2025-02-26T12:32:04Z

Text replacement - "\{\{GameCategory\|armaR\|Modding\|(Guidelines|Tutorials)\|([^=↵]*)\}\}" to "{{GameCategory|armaR|Modding|$2|$1}}"

← Older revision		Revision as of 14:32, 26 February 2025
Line 140:		Line 140:


	{{GameCategory\|armaR\|Modding~~\|Tutorials~~\|Official Tools\|Workbench}}		{{GameCategory\|armaR\|Modding\|Official Tools\|Workbench\|Tutorials}}

Lou Montana: Some wiki formatting

2023-06-19T17:10:09Z

Some wiki formatting

← Older revision		Revision as of 19:10, 19 June 2023
Line 121:		Line 121:

	3 new input boxes were created in {{hl\|.siga}} file in order Sig1, Sig3, Sig2. In script, using SignalManager's {{hl\|FindSignal}} method:		3 new input boxes were created in {{hl\|.siga}} file in order Sig1, Sig3, Sig2. In script, using SignalManager's {{hl\|FindSignal}} method:
	{\| class="wikitable"		{\| class="wikitable align-center"
	! FindSignal		! FindSignal
	! Expected index		! Expected index

Lou Montana: Text replacement - "\{\{Link\|enfusion.*\.c\|([A-Za-z0-9_]+)\}\}" to "{{Link/Enfusion|armaR|$1}}"

2023-01-05T11:04:38Z

Text replacement - "\{\{Link\|enfusion.*\.c\|([A-Za-z0-9_]+)\}\}" to "{{Link/Enfusion|armaR|$1}}"

← Older revision		Revision as of 13:04, 5 January 2023
Line 111:		Line 111:
	== Vehicle Setup ==		== Vehicle Setup ==

	Now, the last thing to be done is to set up the vehicle. For that, a {{Link\|~~enfusion://ResourceManager/~ArmaReforger:scripts/Game/generated/Components/CarProcAnimComponent.c~~\|CarProcAnimComponent}} has to exist on the vehicle:		Now, the last thing to be done is to set up the vehicle. For that, a {{Link/Enfusion\|armaR\|CarProcAnimComponent}} has to exist on the vehicle:

	Hit the "'''+'''" button in its Parameters section and add a new '''ProcAnimParams'''.		Hit the "'''+'''" button in its Parameters section and add a new '''ProcAnimParams'''.

Lou Montana: Text replacement - "" to ""

2022-07-30T18:18:32Z

Text replacement - "</syntaxhighlight>" to "</enforce>"

← Older revision		Revision as of 20:18, 30 July 2022
Line 126:		Line 126:
	! Actual index		! Actual index
	\|-		\|-
	\| <enforce>int sigInd1 = m_SignalManager.FindSignal("Sig1");</~~syntaxhighlight~~>		\| <enforce>int sigInd1 = m_SignalManager.FindSignal("Sig1");</enforce>
	\| 0		\| 0
	\| 0		\| 0
	\|-		\|-
	\| <enforce>int sigInd2 = m_SignalManager.FindSignal("Sig2");</~~syntaxhighlight~~>		\| <enforce>int sigInd2 = m_SignalManager.FindSignal("Sig2");</enforce>
	\| 1		\| 1
	\| 2		\| 2
	\|-		\|-
	\| <enforce>int sigInd3 = m_SignalManager.FindSignal("Sig3");</~~syntaxhighlight~~>		\| <enforce>int sigInd3 = m_SignalManager.FindSignal("Sig3");</enforce>
	\| 2		\| 2
	\| 1		\| 1

Lou Montana: Text replacement - "" to ""

2022-07-30T18:17:49Z

Text replacement - "<syntaxhighlight lang="C#">" to "<enforce>"

← Older revision		Revision as of 20:17, 30 July 2022
Line 126:		Line 126:
	! Actual index		! Actual index
	\|-		\|-
	\| <~~syntaxhighlight lang="C#"~~>int sigInd1 = m_SignalManager.FindSignal("Sig1");</syntaxhighlight>		\| <enforce>int sigInd1 = m_SignalManager.FindSignal("Sig1");</syntaxhighlight>
	\| 0		\| 0
	\| 0		\| 0
	\|-		\|-
	\| <~~syntaxhighlight lang="C#"~~>int sigInd2 = m_SignalManager.FindSignal("Sig2");</syntaxhighlight>		\| <enforce>int sigInd2 = m_SignalManager.FindSignal("Sig2");</syntaxhighlight>
	\| 1		\| 1
	\| 2		\| 2
	\|-		\|-
	\| <~~syntaxhighlight lang="C#"~~>int sigInd3 = m_SignalManager.FindSignal("Sig3");</syntaxhighlight>		\| <enforce>int sigInd3 = m_SignalManager.FindSignal("Sig3");</syntaxhighlight>
	\| 2		\| 2
	\| 1		\| 1

Dedmen: Typo fixes

2022-07-18T09:47:31Z

Typo fixes

← Older revision		Revision as of 11:47, 18 July 2022
Line 16:		Line 16:
	== Input and Output ==		== Input and Output ==

	# In the {{hl\|.siga}} file, create two new '''Inputs''' and name them '''EngineRPM''' and '''EngineOn'''. - these are this animation's two ~~parametres~~.<!--		# In the {{hl\|.siga}} file, create two new '''Inputs''' and name them '''EngineRPM''' and '''EngineOn'''. - these are this animation's two parameters.<!--
	--> In the same file, create an '''Output''' and name it '''EngineShake''' (the naming here is up to the modder).		--> In the same file, create an '''Output''' and name it '''EngineShake''' (the naming here is up to the modder).

Line 42:		Line 42:
	== Signal Processing ==		== Signal Processing ==

	Now that the {{hl\|.pap}} project file has been ~~setup~~, it is time to work with the {{hl\|.siga}} file, in order to process the signal from the engine.		Now that the {{hl\|.pap}} project file has been set up, it is time to work with the {{hl\|.siga}} file, in order to process the signal from the engine.
	The following picture represents the wanted end result and is described in the next steps.		The following picture represents the wanted end result and is described in the next steps.

Line 69:		Line 69:
	[[File:armareforger_proceduralanimationeditor-tutorial-engine-rpm-result.png]]		[[File:armareforger_proceduralanimationeditor-tutorial-engine-rpm-result.png]]

	The exhaust now shakes according to engine's RPM as well as a little ~~randomisation~~.		The exhaust now shakes according to engine's RPM as well as a little randomization.

	=== Engine On ===		=== Engine On ===
Line 111:		Line 111:
	== Vehicle Setup ==		== Vehicle Setup ==

	Now, the last thing to be done is to ~~setup~~ the vehicle. For that a {{Link\|enfusion://ResourceManager/~ArmaReforger:scripts/Game/generated/Components/CarProcAnimComponent.c\|CarProcAnimComponent}} has to exist on the vehicle:		Now, the last thing to be done is to set up the vehicle. For that, a {{Link\|enfusion://ResourceManager/~ArmaReforger:scripts/Game/generated/Components/CarProcAnimComponent.c\|CarProcAnimComponent}} has to exist on the vehicle:

	Hit the "'''+'''" button in its Parameters section and add a new '''ProcAnimParams'''.		Hit the "'''+'''" button in its Parameters section and add a new '''ProcAnimParams'''.

Lou Montana: Fix →

2022-07-18T09:24:23Z

Fix <wiki/> → <nowiki/>

← Older revision		Revision as of 11:24, 18 July 2022
Line 25:		Line 25:
	* In the new window, navigate to the existing {{hl\|.siga}} file and press OK		* In the new window, navigate to the existing {{hl\|.siga}} file and press OK
	* Create two new nodes '''RotationMake''' and '''RotationSet'''		* Create two new nodes '''RotationMake''' and '''RotationSet'''
	* Connect the '''Signal'''<~~wiki~~/>'s EngineShake output to both X and Y axis inputs of the '''RotationMake''' node		* Connect the '''Signal'''<nowiki/>'s EngineShake output to both X and Y axis inputs of the '''RotationMake''' node
	* Connect '''RotationMake'''<nowiki/>'s Out to '''RotationSet'''<nowiki/>'s Rotation input		* Connect '''RotationMake'''<nowiki/>'s Out to '''RotationSet'''<nowiki/>'s Rotation input
	* In the view window, select the vehicle:		* In the view window, select the vehicle:

Lou Montana: Add image

2022-06-28T15:45:21Z

Add image

← Older revision		Revision as of 17:45, 28 June 2022
Line 36:		Line 36:
	The same window can be used for work preview but bear in mind that in the {{hl\|.siga}} file's chain of nodes; no Smoother node can be present for this.		The same window can be used for work preview but bear in mind that in the {{hl\|.siga}} file's chain of nodes; no Smoother node can be present for this.
	}}-->		}}-->

			[[File:armareforger_proceduralanimationeditor-tutorial-pap-result.png]]

Lou Montana: Page creation

2022-06-28T15:39:05Z

Page creation

New page

{{TOC|side}}
For the demonstration of how Procedural Animation Editor works, let's see the example of vehicle exhaust, the end of which should be shaking a bit when the engine of the vehicle is on.

This shake should be also affected by vehicle RPM and also be a bit bigger when engine goes on or off. Let's go into it.

{{Feature|informative|See [[Arma Reforger:Procedural Animation Editor|Procedural Animation Editor]] documentation.}}

== Create Files ==

* Create a new {{hl|.pap}} and {{hl|.siga}} file:
** {{hl|File > New > Project}} for the {{hl|.pap}} file (or {{Controls|Ctrl|Shift|N}})
** {{hl|File > New > Signal}} for the {{hl|.siga}} file

== Input and Output ==

# In the {{hl|.siga}} file, create two new '''Inputs''' and name them '''EngineRPM''' and '''EngineOn'''. - these are this animation's two parametres. In the same file, create an '''Output''' and name it '''EngineShake''' (the naming here is up to the modder).

== Project Setup ==

* In the {{hl|.pap}} file, click on '''Signal'''
* In the new window, navigate to the existing {{hl|.siga}} file and press OK
* Create two new nodes '''RotationMake''' and '''RotationSet'''
* Connect the '''Signal'''<wiki/>'s EngineShake output to both X and Y axis inputs of the '''RotationMake''' node
* Connect '''RotationMake'''<nowiki/>'s Out to '''RotationSet'''<nowiki/>'s Rotation input
* In the view window, select the vehicle:
** Click on the '''SelectModel''' button
** Search for {{hl|UAZ469_base.xob}} and select the {{hl|.xob}} file
* Select on the model the bone to be used. Click on the exhaust bone (should be {{hl|v_exhaust}} and select '''Add bone''' - this will create a '''Bone''' node
* Connect this new Bone node to '''RotationSet'''<nowiki/>'s In input


== Signal Processing ==

Now that the {{hl|.pap}} project file has been setup, it is time to work with the {{hl|.siga}} file, in order to process the signal from the engine.
The following picture represents the wanted end result and is described in the next steps.

[[File:armareforger_proceduralanimationeditor-tutorial-siga-first-step.png]]

The whole process can be divided into two branches:

=== Engine RPM ===

Let's handle the shaking of exhaust based on engine RPM:
* Create a '''Value''' node and set its value to 7500
* Create a '''Div''' node in order to divide engineRPM (value in range 0..~5000) by the '''Value'''<nowiki/>'s set value (7500)
* Connect the '''Input'''<nowiki/> ''engineRPM''<nowiki/>'s Out to '''Div'''<nowiki/>'s In input
* Connect the '''Value'''<nowiki/>'s Out to '''Div'''<nowiki/>'s Divisor input
{{Feature|informative|The value '''7500''' could also have been set directly in the '''Div''' node.}}
* Create a '''Random''' node to generate a random value
** Set its min value to -0.6 and max value to 0.6 to make it generate a random number in -0.6..+0.6 range
* Create a '''Mul''' node to multiply the result of the division output by the random value
* Connect the '''Div'''<nowiki/>'s Out and the '''Random'''<nowiki/>'s Out to '''Mul'''<nowiki/>'s In
* Create a '''Smoother''' node
** Set its Fade-in and Fade-out values to 300 (milliseconds)
** Keep "Interpolate First" ticked
* Connect the '''Mul'''<nowiki/>'s Out to '''Smoother'''<nowiki/>'s In
* Connect the '''Smoother'''<nowiki/>'s Out to '''Output''' engineShake's In

[[File:armareforger_proceduralanimationeditor-tutorial-engine-rpm-result.png]]

The exhaust now shakes according to engine's RPM as well as a little randomisation.

=== Engine On ===

Let's handle a shake of exhaust on start and stop of the engine:
* Create a '''Smoother''' node, keep its default values
* Connect the '''Input''' ''engineOn''<nowiki/>'s Out to this '''Smooker'''<nowiki/>'s In
* Create a '''{{sic|Convertor}}''' node
** Set this node's Intervals' values (min/max/out): [0] 0.100/0.300/0.500 [1] 0.301/0.600/1.000 [2] 0.601/0.900/0.500 [3] 0.901/1.000/0.000
{{Feature|informative|These values will create the effect of a stronger shake on engine start / stop (smoothed later).}}
* Connect the '''Smoother'''<nowiki/>'s Out to the '''{{sic|Convertor}}'''<nowiki/>'s In ('''not''' Default)
* Create another '''Smoother''' node
** Set its Fade-in value to 300 (milliseconds) and this time set its Fade-out value to '''0'''
* Connect the '''{{sic|Convertor}}'''<nowiki/>'s Out to the '''Smoother'''<nowiki/>'s In
* Create a '''Random''' node
* Create a '''Mul''' node to multiply '''Smoother'''<nowiki/>'s and '''Random'''<nowiki/>'s Out values
* Connect the '''Smoother'''<nowiki/>'s Out and the '''Random'''<nowiki/>'s Out to '''Mul'''<nowiki/>'s In

[[File:armareforger_proceduralanimationeditor-tutorial-engine-on-result.png]]

The whole Signal file is not completed! There are still "dangling" nodes.

[[File:armareforger_proceduralanimationeditor-tutorial-engine-intermediate-result.png]]

Now, in order to merge (by sum) engineRPM and engineOn's results, we will change engineRPM's flow:
* Disconnect '''Output''' ''engineShake'' from the '''Smoother''' node{{Feature|informative|In order to do so, click on the node link and press {{Controls|Del}}.}}
* Create a '''Sum''' node
* Connect the two open ends to it: the last '''Smoother''' node from ''engineRPM'' and the last '''Mul''' node from ''engineOn''
* Connect the '''Sum'''<nowiki/>'s Out to ''engineShake''

The final result should look like the following image.
[[File:armareforger_proceduralanimationeditor-tutorial-engine-final-result.png]]

== Vehicle Setup ==

Now, the last thing to be done is to setup the vehicle. For that a {{Link|enfusion://ResourceManager/~ArmaReforger:scripts/Game/generated/Components/CarProcAnimComponent.c|CarProcAnimComponent}} has to exist on the vehicle:

Hit the "'''+'''" button in its Parameters section and add a new '''ProcAnimParams'''.
As a '''ResourceName''' navigate to the created {{hl|.pap}} file, in '''BoneNames''' click on "'''+'''" button and select the bone to be animated.

Index of added bones on ProcAnimComponent has to be same as the order in {{hl|.pap}} file.

Same goes for inputs in {{hl|.siga}} file, or the following could happen:

3 new input boxes were created in {{hl|.siga}} file in order Sig1, Sig3, Sig2. In script, using SignalManager's {{hl|FindSignal}} method:
{| class="wikitable"
! FindSignal
! Expected index
! Actual index
|-
| <syntaxhighlight lang="C#">int sigInd1 = m_SignalManager.FindSignal("Sig1");</syntaxhighlight>
| 0
| 0
|-
| <syntaxhighlight lang="C#">int sigInd2 = m_SignalManager.FindSignal("Sig2");</syntaxhighlight>
| 1
| 2
|-
| <syntaxhighlight lang="C#">int sigInd3 = m_SignalManager.FindSignal("Sig3");</syntaxhighlight>
| 2
| 1
|}

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