Tayfunwiki at 19:41, 24 December 2023

2023-12-24T19:41:01Z

← Older revision		Revision as of 15:41, 24 December 2023
Line 8:		Line 8:
	* Enum Type: <code>SchemeResult</code>		* Enum Type: <code>SchemeResult</code>
	* Values:		* Values:
	** <code>None</code>: Indicates no specific result ~~or an uninitialized state~~.		** <code>None</code>: Indicates no specific result.
	** <code>Success</code>: Represents a successful completion of the scheme.		** <code>Success</code>: Represents a successful completion of the scheme.
	** <code>Failed</code>: Signifies that the scheme did not achieve its intended outcome.		** <code>Failed</code>: Signifies that the scheme did not achieve its intended outcome.

Tayfunwiki: Created page with "== `onSchemeEnded` Event in Actor Class == === Overview === The `onSchemeEnded` event is a critical component of the `Actor` class, triggered upon the conclusion of a scheme. It's instrumental in games where the outcomes of schemes drive narrative developments, character interactions, or gameplay changes. === Description of `SchemeResult` Enum === * Enum Type: `SchemeResult` * Values: ** `None`: Indicat..."

2023-12-24T19:40:10Z

Created page with "== <code>onSchemeEnded</code> Event in Actor Class == === Overview === The <code>onSchemeEnded</code> event is a critical component of the <code>Actor</code> class, triggered upon the conclusion of a scheme. It's instrumental in games where the outcomes of schemes drive narrative developments, character interactions, or gameplay changes. === Description of <code>SchemeResult</code> Enum === * Enum Type: <code>SchemeResult</code> * Values: ** <code>None</code>: Indicat..."

New page

== <code>onSchemeEnded</code> Event in Actor Class ==

=== Overview ===
The <code>onSchemeEnded</code> event is a critical component of the <code>Actor</code> class, triggered upon the conclusion of a scheme. It's instrumental in games where the outcomes of schemes drive narrative developments, character interactions, or gameplay changes.

=== Description of <code>SchemeResult</code> Enum ===

* Enum Type: <code>SchemeResult</code>
* Values:
** <code>None</code>: Indicates no specific result or an uninitialized state.
** <code>Success</code>: Represents a successful completion of the scheme.
** <code>Failed</code>: Signifies that the scheme did not achieve its intended outcome.

=== Description of <code>onSchemeEnded</code> Event ===

* Event Type: <code>Action<Scheme, SchemeResult></code>
* Functionality: Activates when a scheme involving the actor ends, providing insights into both the scheme and its outcome. The event handler receives the scheme that ended and its result as defined by the <code>SchemeResult</code> enum. This setup allows for tailored reactions based on the nature and success or failure of the scheme.

=== Usage ===
The event is used to trigger specific actions or logic in response to the conclusion of schemes, such as updating game states, adjusting character statuses, or advancing the storyline based on the scheme's result.

=== Subscribing to the Event ===
Subscribe to the <code>onSchemeEnded</code> event within a MonoBehaviour script to handle the end of schemes. Ensure to unsubscribe from the event appropriately to maintain optimal performance and prevent memory leaks.

=== Example of Usage ===
<syntaxhighlight lang="c#">
public class SchemeOutcomeHandler : MonoBehaviour {
public Actor actor;

void Start() {
if (actor != null) {
actor.onSchemeEnded += OnSchemeEnded;
}
}

private void OnSchemeEnded(Scheme scheme, SchemeResult result) {
Debug.Log($"Scheme {scheme.SchemeName} ended with result: {result}");
// Custom logic based on the scheme's outcome
}

void OnDestroy() {
if (actor != null) {
actor.onSchemeEnded -= OnSchemeEnded;
}
}
}
</syntaxhighlight>In this Unity script example, the <code>SchemeOutcomeHandler</code> is attached to a GameObject and listens for the <code>onSchemeEnded</code> event from an <code>Actor</code>. When a scheme ends, it triggers the <code>OnSchemeEnded</code> method, allowing for responses tailored to the specific outcome of the scheme.

=== Remarks ===

* The <code>onSchemeEnded</code> event with <code>SchemeResult</code> allows for nuanced and strategic gameplay, enhancing player engagement through responsive and outcome-based scenarios.
* Understanding and utilizing the different outcomes in <code>SchemeResult</code> is key to creating a dynamic and interactive game environment.
* This event is particularly crucial in narrative-rich and strategy-focused games where the consequences of player actions significantly impact the game's progression.

OnSchemeEnded - Revision history

Tayfunwiki at 19:41, 24 December 2023