Arma 3: Virtual Reality Custom Courses - Revision history

Lou Montana: Text replacement - " ( class [a-zA-Z0-9_]+): ([a-zA-Z0-9_]+ *) " to " $1 : $2 "

2023-12-06T09:58:11Z

Text replacement - " ( *class [a-zA-Z0-9_]+): *([a-zA-Z0-9_]+ *) " to " $1 : $2 "

← Older revision		Revision as of 11:58, 6 December 2023
Line 7:		Line 7:
	{		{
	class Default;		class Default;
	class MyCourse1: Default		class MyCourse1 : Default
	{		{
	title = "Course Name";		title = "Course Name";

Lou Montana: Some wiki formatting

2022-07-29T13:12:31Z

Some wiki formatting

Lou Montana: Text replacement - "\[\[Functions[ _]Library[ _]$Arma[ _]3$" to "[[Arma 3: Functions Library"

2021-08-04T16:33:25Z

Text replacement - "\[\[Functions[ _]Library[ _]$Arma[ _]3$" to "[[Arma 3: Functions Library"

← Older revision		Revision as of 18:33, 4 August 2021
Line 37:		Line 37:
	'''title:''' Text that will be shown ingame during Course selection or when loading a Stage.		'''title:''' Text that will be shown ingame during Course selection or when loading a Stage.

	'''function:''' Function to run for each Stage. Must be defined in cfgFunctions (see [[~~Functions_Library_(Arma_3)~~#Adding_a_Function\|the Arma 3 functions library]], VR functions are usually defined in category "VR").		'''function:''' Function to run for each Stage. Must be defined in cfgFunctions (see [[Arma 3: Functions Library#Adding_a_Function\|the Arma 3 functions library]], VR functions are usually defined in category "VR").

	=== Functions ===		=== Functions ===

Lou Montana: Text replacement - "{{Quote|" to "{{Feature|quote|"

2021-02-04T18:11:26Z

Text replacement - "{{Quote|" to "{{Feature|quote|"

← Older revision		Revision as of 20:11, 4 February 2021
Line 73:		Line 73:

	The End!		The End!
	{{~~Quote~~\|I hope I covered everything here. Have fun creating your own VR Courses!\|{{User\|Jezuro}}}}		{{Feature\|quote\|I hope I covered everything here. Have fun creating your own VR Courses!\|{{User\|Jezuro}}}}


	{{GameCategory\|arma3\|Editing}}		{{GameCategory\|arma3\|Editing}}

Lou Montana: Text replacement - "{{quote" to "{{Quote"

2021-01-02T04:43:17Z

Text replacement - "{{quote" to "{{Quote"

← Older revision		Revision as of 06:43, 2 January 2021
Line 73:		Line 73:

	The End!		The End!
	{{~~quote~~\|I hope I covered everything here. Have fun creating your own VR Courses!\|{{User\|Jezuro}}}}		{{Quote\|I hope I covered everything here. Have fun creating your own VR Courses!\|{{User\|Jezuro}}}}


	{{GameCategory\|arma3\|Editing}}		{{GameCategory\|arma3\|Editing}}

Lou Montana: Text replacement - "Category:Arma 3: Editing" to "{{GameCategory|arma3|Editing}}"

2020-07-26T17:31:48Z

Text replacement - "Category:Arma 3: Editing" to "{{GameCategory|arma3|Editing}}"

← Older revision		Revision as of 19:31, 26 July 2020
Line 76:		Line 76:


	~~[[Category:Arma 3:~~ Editing]]		{{GameCategory\|arma3\|Editing}}

Lou Montana: Page formatting and category addition

2019-11-15T17:43:00Z

Page formatting and category addition

← Older revision		Revision as of 19:43, 15 November 2019
Line 1:		Line 1:
	~~===~~ Here's a basic guide on how to configure your own VR training courses~~: ===~~		Here is a basic guide on how to configure your own VR training courses. If there are some community Courses configured, a new selector will appear with a list of the Courses. This selector will have different colour than the official ones.

	If there are some community Courses configured, a new selector will appear with a list of the Courses. This selector will have different colour than the official ones.

	=== Config ===		=== Config ===

	class CfgVRCourses		<syntaxhighlight lang="cpp">
	{		class CfgVRCourses
	class Default;		{
	class MyCourse1: Default		class Default;
	{		class MyCourse1: Default
	title = "Course Name";		{
	icon = "\A3\Structures_F_Bootcamp\VR\Helpers\Data\VR_Symbol_default_CA.paa";		title = "Course Name";
	class Stages		icon = "\A3\Structures_F_Bootcamp\VR\Helpers\Data\VR_Symbol_default_CA.paa";
	{		class Stages
	class Stage1		{
	{		class Stage1
	title = "Stage 1 Name";		{
	function = "BIS_fnc_VRFunctionName1";		title = "Stage 1 Name";
	};		function = "BIS_fnc_VRFunctionName1";
	class Stage2		};
	{		class Stage2
	title = "Stage 2 Name";		{
	function = "BIS_fnc_VRFunctionName2";		title = "Stage 2 Name";
	};		function = "BIS_fnc_VRFunctionName2";
	class Stage3		};
	{		class Stage3
	title = "Stage 3 Name";		{
	function = "BIS_fnc_VRFunctionName3";		title = "Stage 3 Name";
	};		function = "BIS_fnc_VRFunctionName3";
	};		};
	};		};
	};		};
			};
			</syntaxhighlight>

	'''icon:''' Path to icon that will be shown on a billboard throughout the Course.		'''icon:''' Path to icon that will be shown on a billboard throughout the Course.
Line 43:		Line 43:
	Stage functions are typically FSMs (you can get the FSM Editor [[FSM Editor\|here]]). There are certain '''guidelines''' to follow:		Stage functions are typically FSMs (you can get the FSM Editor [[FSM Editor\|here]]). There are certain '''guidelines''' to follow:

	- player's starting coordinates are always ''markerPos "BIS_center"''		* player's starting coordinates are always ''markerPos "BIS_center"''
			** you should use coordinates relative to this one for spawning your assets

	--- you should ~~use coordinates relative to~~ this ~~one for spawning your assets~~		* there is a brief timeout before player gains control in a Stage - you can spawn all your assets during this period
			** you can determinate the moment player gains control by checking variable ''BIS_interruptable'' for ''TRUE''
			** any mission tasks or hints should be created after this period, once player is actually ingame

	- there is a ~~brief timeout before player gains control in a Stage~~ - ~~you can spawn all your assets during this period~~		* there is a logic unit used for icon helper (group icon) - ''BIS_icon'' and its group, ''BIS_iconGrp''
			** do not delete these!<br>Example of use:
			BIS_icon attachTo [BIS_UAV, [0,0,-3.5]]; BIS_iconGrp setGroupIconParams [BIS_TT_colorWarning, "", 1, TRUE];

	-~~-- you~~ can ~~determinate the moment player gains control by checking~~ variable ''~~BIS_interruptable'' for ''TRUE~~''		* if player wanders too far away from his starting position, he is automatically moved back - default allowed radius is 100m
			** this can be changed via variable ''BIS_stageArea'' in a Stage function.<br>Example of use:
			BIS_stageArea = 150;

	~~---~~ any ~~mission tasks or hints should~~ be ~~created after this period, once player is actually ingame~~		* any assets you spawn will be deleted automatically when the Stage ends

	~~- there~~ is ~~a logic unit used for icon helper (group icon) - ''BIS_icon'' and its group, ''BIS_iconGrp''~~		* a Stage is completed by using this code: <code>call BIS_fnc_VR_stageDone;</code>

	~~--- do not delete these~~!		* always make sure you've properly terminated your function upon Stage end; keep in mind player can fail a Stage too
			** for Stage failure, use code before you terminate the function: <code>[] spawn BIS_fnc_VR_stageFailed;</code>
			** condition to check player's "death" or him leaving the Stage: <code>damage player > 0.015 \|\| !BIS_interruptable</code>
			** you don't need to call any code in this case, just make sure to properly terminate the function

	~~---~~ example ~~of use:~~		=== Stage function example ===
	~~BIS_icon attachTo [BIS_UAV, [0,0,-3.5]]; BIS_iconGrp setGroupIconParams [BIS_TT_colorWarning, "", 1, TRUE];~~
	~~- if player wanders too far away from his starting position, he is automatically moved back - default allowed radius is 100m~~

	~~--- this can be changed via variable ''BIS_stageArea~~'' in a Stage ~~function~~		To help you understand how a typical Stage FSM may look like, here's a link to a basic Stage function (it's a slightly tweaked Stage 2 of the Launchers Course):
			* https://www.dropbox.com/s/5429wbhsl4f0sky/fn_VRCourseExample.fsm

	~~--- example of use:~~		The End!
	~~BIS_stageArea = 150;~~		{{quote\|I hope I covered everything here. Have fun creating your own VR Courses!\|{{User\|Jezuro}}}}
	~~- any assets you spawn will be deleted automatically when the Stage ends~~

	~~- a Stage is completed by using this code:~~
	~~call BIS_fnc_VR_stageDone;~~
	~~- always make sure you've properly terminated~~ your ~~function upon Stage end; keep in mind player can fail a Stage too~~

	~~--- for Stage failure, use code before you terminate the function:~~
	~~[] spawn BIS_fnc_VR_stageFailed;~~
	~~--- condition to check player's "death" or him leaving the Stage:~~
	~~damage player > 0.015~~ \|\| ~~!BIS_interruptable~~
	~~--- you don't need to call any code in this case, just make sure to properly terminate the function~~

	~~=== Stage function example ===~~
	To help you understand how a typical Stage FSM may look like, here's a link to a basic Stage function (it's a slightly tweaked Stage 2 of the Launchers Course): https://www.dropbox.com/s/5429wbhsl4f0sky/fn_VRCourseExample.fsm

	~~=== The End ===~~		[[Category:Arma 3: Editing]]
	~~I hope I covered everything here. Have fun creating your own VR Courses!~~

Lou Montana: Lou Montana moved page Arma3: Virtual Reality Custom Courses to Arma 3: Virtual Reality Custom Courses: Category name

2019-11-15T17:28:18Z

Lou Montana moved page Arma3: Virtual Reality Custom Courses to Arma 3: Virtual Reality Custom Courses: Category name

← Older revision	Revision as of 19:28, 15 November 2019
(No difference)

Tom 48 97 at 13:56, 15 July 2014

2014-07-15T13:56:44Z

← Older revision		Revision as of 15:56, 15 July 2014
Line 37:		Line 37:
	'''title:''' Text that will be shown ingame during Course selection or when loading a Stage.		'''title:''' Text that will be shown ingame during Course selection or when loading a Stage.

	'''function:''' Function to run for each Stage. Must be defined in cfgFunctions (see ~~https://community.bistudio.com/wiki/~~Functions_Library_~~%28Arma_3%29~~#Adding_a_Function, VR functions are usually defined in category "VR").		'''function:''' Function to run for each Stage. Must be defined in cfgFunctions (see [[Functions_Library_(Arma_3)#Adding_a_Function\|the Arma 3 functions library]], VR functions are usually defined in category "VR").

	=== Functions ===		=== Functions ===

	Stage functions are typically FSMs (you can get the ~~FM editor~~ here~~: https://community.bistudio.com/wiki/BI_Tools_2.5~~). There are certain '''guidelines''' to follow:		Stage functions are typically FSMs (you can get the FSM Editor [[FSM Editor\|here]]). There are certain '''guidelines''' to follow:

	- player's starting coordinates are always ''markerPos "BIS_center"''		- player's starting coordinates are always ''markerPos "BIS_center"''

Jezuro bi wiki: Created page with "=== Here's a basic guide on how to configure your own VR training courses: === If there are some community Courses configured, a new selector will appear with a list of the C..."

2014-07-09T15:09:48Z

Created page with "=== Here's a basic guide on how to configure your own VR training courses: === If there are some community Courses configured, a new selector will appear with a list of the C..."

New page

=== Here's a basic guide on how to configure your own VR training courses: ===

If there are some community Courses configured, a new selector will appear with a list of the Courses. This selector will have different colour than the official ones.

=== Config ===

class CfgVRCourses
{
class Default;
class MyCourse1: Default
{
title = "Course Name";
icon = "\A3\Structures_F_Bootcamp\VR\Helpers\Data\VR_Symbol_default_CA.paa";
class Stages
{
class Stage1
{
title = "Stage 1 Name";
function = "BIS_fnc_VRFunctionName1";
};
class Stage2
{
title = "Stage 2 Name";
function = "BIS_fnc_VRFunctionName2";
};
class Stage3
{
title = "Stage 3 Name";
function = "BIS_fnc_VRFunctionName3";
};
};
};
};

'''icon:''' Path to icon that will be shown on a billboard throughout the Course.

'''title:''' Text that will be shown ingame during Course selection or when loading a Stage.

'''function:''' Function to run for each Stage. Must be defined in cfgFunctions (see https://community.bistudio.com/wiki/Functions_Library_%28Arma_3%29#Adding_a_Function, VR functions are usually defined in category "VR").

=== Functions ===

Stage functions are typically FSMs (you can get the FM editor here: https://community.bistudio.com/wiki/BI_Tools_2.5). There are certain '''guidelines''' to follow:

- player's starting coordinates are always ''markerPos "BIS_center"''

--- you should use coordinates relative to this one for spawning your assets

- there is a brief timeout before player gains control in a Stage - you can spawn all your assets during this period

--- you can determinate the moment player gains control by checking variable ''BIS_interruptable'' for ''TRUE''

--- any mission tasks or hints should be created after this period, once player is actually ingame

- there is a logic unit used for icon helper (group icon) - ''BIS_icon'' and its group, ''BIS_iconGrp''

--- do not delete these!

--- example of use:
BIS_icon attachTo [BIS_UAV, [0,0,-3.5]]; BIS_iconGrp setGroupIconParams [BIS_TT_colorWarning, "", 1, TRUE];
- if player wanders too far away from his starting position, he is automatically moved back - default allowed radius is 100m

--- this can be changed via variable ''BIS_stageArea'' in a Stage function

--- example of use:
BIS_stageArea = 150;
- any assets you spawn will be deleted automatically when the Stage ends

- a Stage is completed by using this code:
call BIS_fnc_VR_stageDone;
- always make sure you've properly terminated your function upon Stage end; keep in mind player can fail a Stage too

--- for Stage failure, use code before you terminate the function:
[] spawn BIS_fnc_VR_stageFailed;
--- condition to check player's "death" or him leaving the Stage:
damage player > 0.015 || !BIS_interruptable
--- you don't need to call any code in this case, just make sure to properly terminate the function

=== Stage function example ===
To help you understand how a typical Stage FSM may look like, here's a link to a basic Stage function (it's a slightly tweaked Stage 2 of the Launchers Course): https://www.dropbox.com/s/5429wbhsl4f0sky/fn_VRCourseExample.fsm

=== The End ===
I hope I covered everything here. Have fun creating your own VR Courses!

← Older revision		Revision as of 15:12, 29 July 2022
Line 45:		Line 45:
	* player's starting coordinates are always ''markerPos "BIS_center"''		* player's starting coordinates are always ''markerPos "BIS_center"''
	** you should use coordinates relative to this one for spawning your assets		** you should use coordinates relative to this one for spawning your assets

	* there is a brief timeout before player gains control in a Stage - you can spawn all your assets during this period		* there is a brief timeout before player gains control in a Stage - you can spawn all your assets during this period
	** you can determinate the moment player gains control by checking variable ''BIS_interruptable'' for ''TRUE''		** you can determinate the moment player gains control by checking variable ''BIS_interruptable'' for ''TRUE''
	** any mission tasks or hints should be created after this period, once player is actually ingame		** any mission tasks or hints should be created after this period, once player is actually ingame

	* there is a logic unit used for icon helper (group icon) - ''BIS_icon'' and its group, ''BIS_iconGrp''		* there is a logic unit used for icon helper (group icon) - ''BIS_icon'' and its group, ''BIS_iconGrp''
	** do not delete these!<br>Example of use:		** do not delete these!<br>Example of use: <sqf>
	BIS_icon attachTo [BIS_UAV, [0,0,-3.5]]; BIS_iconGrp setGroupIconParams [BIS_TT_colorWarning, "", 1, ~~TRUE~~];		BIS_icon attachTo [BIS_UAV, [0, 0, -3.5]];
			BIS_iconGrp setGroupIconParams [BIS_TT_colorWarning, "", 1, true];
			</sqf>
	* if player wanders too far away from his starting position, he is automatically moved back - default allowed radius is 100m		* if player wanders too far away from his starting position, he is automatically moved back - default allowed radius is 100m
	** this can be changed via variable ''BIS_stageArea'' in a Stage function.<br>Example of use:		** this can be changed via variable ''BIS_stageArea'' in a Stage function.<br>Example of use: <sqf>BIS_stageArea = 150;</sqf>
	BIS_stageArea = 150;

	* any assets you spawn will be deleted automatically when the Stage ends		* any assets you spawn will be deleted automatically when the Stage ends
			* a Stage is completed by using this code: <sqf>call BIS_fnc_VR_stageDone;</sqf>
	* a Stage is completed by using this code: <~~code~~>call BIS_fnc_VR_stageDone;</~~code~~>

	* always make sure you've properly terminated your function upon Stage end; keep in mind player can fail a Stage too		* always make sure you've properly terminated your function upon Stage end; keep in mind player can fail a Stage too
	** for Stage failure, use code before you terminate the function: <~~code~~>[] spawn BIS_fnc_VR_stageFailed;</~~code~~>		** for Stage failure, use code before you terminate the function: <sqf>[] spawn BIS_fnc_VR_stageFailed;</sqf>
	** condition to check player's "death" or him leaving the Stage: <~~code~~>damage player > 0.015 \|\| !BIS_interruptable</~~code~~>		** condition to check player's "death" or him leaving the Stage: <sqf>damage player > 0.015 \|\| !BIS_interruptable</sqf>
	** you don't need to call any code in this case, just make sure to properly terminate the function		** you don't need to call any code in this case, just make sure to properly terminate the function