Tayfunwiki at 23:00, 9 February 2024

2024-02-09T23:00:02Z

← Older revision		Revision as of 19:00, 9 February 2024
Line 24:		Line 24:
	Scheme schemeToKill = IM.Player.GetScheme(schemeName);		Scheme schemeToKill = IM.Player.GetScheme(schemeName);
	if (schemeToKill != null) {		if (schemeToKill != null) {
	schemeToKill.Kill();		schemeToKill.Schemer.Kill();
	Debug.Log($"Terminated scheme: {schemeName}");		Debug.Log($"Terminated scheme: {schemeName}");
	} else {		} else {

Tayfunwiki: Created page with "== `Kill` Method in Scheme Class == === Overview === The `Kill` method in the Scheme class is used to terminate a scheme immediately. This method is crucial for stopping the progression of a scheme, especially in scenarios where the scheme's continuation is no longer relevant or desired within the game's context. === Syntax === public void Kill(bool dontGoEnd = false) === Description === * Parameter..."

2024-01-04T23:50:58Z

Created page with "== <code>Kill</code> Method in Scheme Class == === Overview === The <code>Kill</code> method in the Scheme class is used to terminate a scheme immediately. This method is crucial for stopping the progression of a scheme, especially in scenarios where the scheme's continuation is no longer relevant or desired within the game's context. === Syntax === <syntaxhighlight lang="c#"> public void Kill(bool dontGoEnd = false) </syntaxhighlight> === Description === * Parameter..."

New page

== <code>Kill</code> Method in Scheme Class ==

=== Overview ===
The <code>Kill</code> method in the Scheme class is used to terminate a scheme immediately. This method is crucial for stopping the progression of a scheme, especially in scenarios where the scheme's continuation is no longer relevant or desired within the game's context.

=== Syntax ===
<syntaxhighlight lang="c#">
public void Kill(bool dontGoEnd = false)
</syntaxhighlight>

=== Description ===

* Parameters:
** <code>dontGoEnd</code> (optional, defaults to <code>false</code>): If set to <code>true</code>, this parameter prevents the scheme from reaching its end node, effectively stopping the scheme without triggering its conclusion logic.
* The method first checks if the <code>Schemer</code> (the entity controlling the scheme) is not null before proceeding to terminate the scheme.

=== Usage ===
The <code>Kill</code> method is typically used in game logic to forcibly end a scheme due to various gameplay events, such as changes in the game's narrative, player decisions, or other conditions that render the continuation of the scheme irrelevant or counterproductive.

=== Example of Usage ===
<syntaxhighlight lang="c#">
public class SchemeTerminator : MonoBehaviour {
void TerminatePlayerScheme(string schemeName) {
Scheme schemeToKill = IM.Player.GetScheme(schemeName);
if (schemeToKill != null) {
schemeToKill.Kill();
Debug.Log($"Terminated scheme: {schemeName}");
} else {
Debug.Log($"Scheme not found: {schemeName}");
}
}
}
</syntaxhighlight>

==== Description ====

* In the <code>TerminatePlayerScheme</code> method, this example demonstrates how to terminate a specific scheme by name. It retrieves the scheme using <code>IM.Player.GetScheme</code> and then calls the <code>Kill</code> method on it.
* The method logs a message indicating whether the scheme was successfully terminated or if it was not found.

=== Remarks ===

* The <code>Kill</code> method is a key tool for managing schemes within a game, allowing for greater control over the narrative and gameplay.
* Proper handling of the termination of schemes is crucial to maintain the integrity and consistency of the game's narrative and mechanics.

Kill - Revision history

Tayfunwiki at 23:00, 9 February 2024