Argon-Runtime-Setup - Revision history

Argony: /* Customizing Runtime Components */

2024-04-11T15:29:02Z

Customizing Runtime Components

← Older revision		Revision as of 08:29, 11 April 2024
Line 40:		Line 40:
	For example:		For example:

	You want to replace the default highlight manager; (perhaps ~~because~~ you want a version that plays an audio effect when an objects becomes highlighted).		You want to replace the default highlight manager; (perhaps you want a version that plays an audio effect when an objects becomes highlighted, for example).

	The core code finds the highlight manager through the '''SceneServices''' object.		The core code finds the highlight manager through the '''SceneServices''' object.

	It asks SceneServices for its OneAtATimeHighlightManager which is of type '''IOneAtATimeHighlightManager'''.		It asks SceneServices for its ''OneAtATimeHighlightManager'' which is of type '''IOneAtATimeHighlightManager'''.

	To set up your custom highlight manager:		To set up your custom highlight manager:
Line 51:		Line 51:
	# Select the SceneServices object in your scene (under DefaultPlayer).		# Select the SceneServices object in your scene (under DefaultPlayer).
	# In the SceneServices inspector, set the property 'One At A Time Highlight Manager' to the object that owns your custom component		# In the SceneServices inspector, set the property 'One At A Time Highlight Manager' to the object that owns your custom component
			# (Recommended) Remove the default Highlight Manager component since it is no longer in use. The component class name is ''HighlightManager'' and is attached to the SceneServices object.

	= Scene Services =		= Scene Services =

Argony: /* Customizing Runtime Components */

2024-04-11T11:54:02Z

Customizing Runtime Components

← Older revision		Revision as of 04:54, 11 April 2024
Line 42:		Line 42:
	You want to replace the default highlight manager; (perhaps because you want a version that plays an audio effect when an objects becomes highlighted).		You want to replace the default highlight manager; (perhaps because you want a version that plays an audio effect when an objects becomes highlighted).

	The core code finds the highlight manager through ~~an object of type~~ '''SceneServices'''.		The core code finds the highlight manager through the '''SceneServices''' object.

	It asks SceneServices for its ~~instance of~~ OneAtATimeHighlightManager which is of type '''IOneAtATimeHighlightManager'''.		It asks SceneServices for its OneAtATimeHighlightManager which is of type '''IOneAtATimeHighlightManager'''.

	To set up your custom highlight manager:		To set up your custom highlight manager:

Argony: /* Scene Services */

2024-04-11T00:58:59Z

Scene Services

← Older revision		Revision as of 17:58, 10 April 2024
Line 55:		Line 55:
	The SceneServices object is an exchange point where the Argon core classes get the machinery they need to work at runtime.		The SceneServices object is an exchange point where the Argon core classes get the machinery they need to work at runtime.

	~~Those component declarations look like this~~:		SceneServices exposes the following references:

	<pre>		<pre>

Argony: /* Customizing Runtime Components */

2024-04-11T00:56:31Z

Customizing Runtime Components

← Older revision		Revision as of 17:56, 10 April 2024
Line 40:		Line 40:
	For example:		For example:

	You want to replace the default ~~simple~~ highlight manager; you want a version that plays an audio effect when an objects becomes highlighted.		You want to replace the default highlight manager; (perhaps because you want a version that plays an audio effect when an objects becomes highlighted).

	The core code finds the highlight manager through an object of type '''SceneServices'''.		The core code finds the highlight manager through an object of type '''SceneServices'''.
Line 49:		Line 49:
	# Write a component that implements IOneAtATimeHighlightManager (defined in the namespace DuksGames.Argon.Adapters)		# Write a component that implements IOneAtATimeHighlightManager (defined in the namespace DuksGames.Argon.Adapters)
	# Add that component to an object in your scene		# Add that component to an object in your scene
	# Select the SceneServices object ~~inside of the instance of DefaultPlayer~~ in your scene.		# Select the SceneServices object in your scene (under DefaultPlayer).
	# In the SceneServices inspector, set the property 'One At A Time Highlight Manager' to the object that owns your custom component		# In the SceneServices inspector, set the property 'One At A Time Highlight Manager' to the object that owns your custom component

Argony: /* Customizing Runtime Components */

2024-04-09T16:32:20Z

Customizing Runtime Components

← Older revision		Revision as of 09:32, 9 April 2024
Line 34:		Line 34:
	= Customizing Runtime Components =		= Customizing Runtime Components =

	To make customizing components easy, Argon's core components always talk to ~~its~~ runtime components through interfaces.		To make customizing components easy, Argon core components always talk to runtime components through interfaces.

	So, to replace an Argon runtime class, you just need to write your own implementation of the interface in question.		So, to replace an Argon runtime class, you just need to write your own implementation of the interface in question.

Argony at 16:26, 9 April 2024

2024-04-09T16:26:44Z

← Older revision		Revision as of 09:26, 9 April 2024
Line 58:		Line 58:

	<pre>		<pre>
	~~[SerializeField] GameObject _CursorLock;~~		public ICursorLocker CursorLocker
	public ICursorLocker CursorLocker ~~=> _CursorLock.GetComponent<ICursorLocker>();~~

	~~[SerializeField] GameObject _CamSwap;~~		public ICamSwap CamSwap
	public ICamSwap CamSwap ~~=> _CamSwap.GetComponent<ICamSwap>();~~

	~~[SerializeField] GameObject _PlayerProvider;~~		public IPlayerProvider PlayerProvider
	public IPlayerProvider PlayerProvider ~~=> _PlayerProvider.GetComponent<IPlayerProvider>();~~

	~~[SerializeField] GameObject _OneAtATimeHighlightManager;~~		public IOneAtATimeHighlightManager OneAtATimeHighlightManager
	public IOneAtATimeHighlightManager OneAtATimeHighlightManager =>
	~~_OneAtATimeHighlightManager.GetComponent<IOneAtATimeHighlightManager>();~~

	~~[SerializeField] GameObject _CamLockSessionOneAtATimeHighlightManager;~~		public ICamLockSessionOneAtATimeHighlightManager CamLockSessionOneAtATimeHighlightManager
	public ICamLockSessionOneAtATimeHighlightManager CamLockSessionOneAtATimeHighlightManager =>
	~~_CamLockSessionOneAtATimeHighlightManager.GetComponent<ICamLockSessionOneAtATimeHighlightManager>();~~

	~~[SerializeField] GameObject _HeadlineDisplay;~~		public IHeadlineDisplay HeadlineDisplay
	public IHeadlineDisplay HeadlineDisplay ~~=> _HeadlineDisplay.GetComponent<IHeadlineDisplay>();~~

	~~[SerializeField] GameObject _PlayerUpdateStack;~~		public IUpdateStack PlayerUpdateStack
	public IUpdateStack PlayerUpdateStack ~~=> _PlayerUpdateStack.GetComponent<IUpdateStack>();~~

	~~[SerializeField] GameObject _ThirdPersonControllerStateManager;~~		public IThirdPersonControllerStateManager ThirdPersonControllerStateManager
	public IThirdPersonControllerStateManager ThirdPersonControllerStateManager =>
	~~_ThirdPersonControllerStateManager.GetComponent<IThirdPersonControllerStateManager>();~~

	~~[SerializeField] GameObject _ProximityClickManager;~~		public IProximityClickManager ProximityClickManager
	public IProximityClickManager ProximityClickManager =>
	~~_ProximityClickManager.GetComponent<IProximityClickManager>();~~		public ICurrentBeaconProvider CurrentBeaconProvider

	~~[SerializeField] GameObject _CurrentBeaconProvider;~~
	~~public ICurrentBeaconProvider CurrentBeaconProvider =>~~
	~~_CurrentBeaconProvider.GetComponent<ICurrentBeaconProvider>();~~
	</pre>		</pre>

			All of the default implementations of these interfaces are included in Argon's source code.

Argony at 15:53, 9 April 2024

2024-04-09T15:53:49Z

← Older revision		Revision as of 08:53, 9 April 2024
Line 55:		Line 55:
	The SceneServices object is an exchange point where the Argon core classes get the machinery they need to work at runtime.		The SceneServices object is an exchange point where the Argon core classes get the machinery they need to work at runtime.

	~~This includes the following components~~:		Those component declarations look like this:
	~~<code>~~

			<pre>
	[SerializeField] GameObject _CursorLock;		[SerializeField] GameObject _CursorLock;
	public ICursorLocker CursorLocker => _CursorLock.GetComponent<ICursorLocker>();		public ICursorLocker CursorLocker => _CursorLock.GetComponent<ICursorLocker>();
Line 92:		Line 92:
	public ICurrentBeaconProvider CurrentBeaconProvider =>		public ICurrentBeaconProvider CurrentBeaconProvider =>
	_CurrentBeaconProvider.GetComponent<ICurrentBeaconProvider>();		_CurrentBeaconProvider.GetComponent<ICurrentBeaconProvider>();
			</pre>
	</~~code~~>

Argony at 15:50, 9 April 2024

2024-04-09T15:50:42Z

@@ Line 32: / Line 32: @@
 And in many scenarios this will mean that you'll want to supply your own classes and components to Argon to replace the equivalent default classes and components.
-To make this easy, Argon's core components talk to its runtime components through interfaces.
+= Customizing Runtime Components =
 So, to replace an Argon runtime class, you just need to write your own implementation of the interface in question.
@@ Line 44: / Line 46: @@
 It asks SceneServices for its instance of OneAtATimeHighlightManager which is of type '''IOneAtATimeHighlightManager'''.
-To supply your custom highlight manager:
+To set up your custom highlight manager:
 # Write a component that implements IOneAtATimeHighlightManager (defined in the namespace DuksGames.Argon.Adapters)
 # Add that component to an object in your scene
 # Select the SceneServices object inside of the instance of DefaultPlayer in your scene.
 # In the SceneServices inspector, set the property 'One At A Time Highlight Manager' to the object that owns your custom component

Argony at 15:24, 9 April 2024

2024-04-09T15:24:50Z

@@ Line 1: / Line 1: @@
-= Why is there a Runtime Setup =
+= Why is there a Runtime? =
 Argon adds components to your objects.
@@ Line 20: / Line 20: @@
 = When do I not need the Runtime? =
 You do not need the runtime if you are only adding standard Unity components--like Rigidbody, Box Collider, etc--with Argon.
 = Why do I want customize the Runtime? =
@@ Line 27: / Line 29: @@
 But you'll likely want to change at least a few things to suit the needs of your game.

Argony at 21:07, 7 April 2024

2024-04-07T21:07:19Z

← Older revision		Revision as of 14:07, 7 April 2024
Line 14:		Line 14:
	Luckily, this is all set up for you already in the ARGON_DefaultPlayer.prefab. Just find it (under Assets >> Argon >> DefaultPlayer) and add it to your scene.		Luckily, this is all set up for you already in the ARGON_DefaultPlayer.prefab. Just find it (under Assets >> Argon >> DefaultPlayer) and add it to your scene.

	The DefaultPlayer prefab has an instance of SceneServices and an object with a IHeadlineDisplay component (named HeadlineFeedback).		The DefaultPlayer prefab has an instance of SceneServices and an object with an IHeadlineDisplay component (named HeadlineFeedback).

	~~The~~ DefaultPlayer prefab has all of the components you need to make all of your Argon components work.		In general, the DefaultPlayer prefab has all of the components you need to make all of your Argon components work.

	= When do I not need the Runtime? =		= When do I not need the Runtime? =
	You do not need the runtime if you are only adding standard Unity components--like Rigidbody, Box Collider, etc--with Argon.		You do not need the runtime if you are only adding standard Unity components--like Rigidbody, Box Collider, etc--with Argon.

	= Why do I want customize the Runtime =		= Why do I want customize the Runtime? =
	The runtime setup that comes packaged in the DefaultPlayer prefab ~~comes with~~ a player attached to a first person camera rig.		The runtime setup that comes packaged in the DefaultPlayer prefab has a player attached to a first person camera rig.

	If you are making a first person game and are happy with the default implementations supplied with Argon, then you're all set.		If you are making a first person game and are happy with the default implementations supplied with Argon, then you're all set.

	But you'll ~~very~~ likely want to change at least a few things to suit the needs of your game.		But you'll likely want to change at least a few things to suit the needs of your game.