Tayfunwiki: Created page with "== `Description` Property in Scheme Class == === Overview === The `Description` property in the Scheme class provides a narrative description of the scheme, offering details about its purpose and implications, such as "Plan to eliminate the target. If it happens, {t*Name} will be eliminated." === Property Definition === [field: SerializeField] public string Description { get; private set; } === Descr..."

2024-01-04T23:08:44Z

Created page with "== <code>Description</code> Property in Scheme Class == === Overview === The <code>Description</code> property in the Scheme class provides a narrative description of the scheme, offering details about its purpose and implications, such as "Plan to eliminate the target. If it happens, {t*Name} will be eliminated." === Property Definition === <syntaxhighlight lang="c#"> [field: SerializeField] public string Description { get; private set; } </syntaxhighlight> === Descr..."

New page

== <code>Description</code> Property in Scheme Class ==

=== Overview ===
The <code>Description</code> property in the Scheme class provides a narrative description of the scheme, offering details about its purpose and implications, such as "Plan to eliminate the target. If it happens, {t*Name} will be eliminated."

=== Property Definition ===
<syntaxhighlight lang="c#">
[field: SerializeField]
public string Description { get; private set; }
</syntaxhighlight>

=== Description ===

* Type: <code>string</code>
* Accessibility: Publicly readable but can only be set within the Scheme class.

=== Functionality ===

* The <code>Description</code> property provides a detailed explanation of what the scheme entails, enhancing player understanding and immersion.
* It can be used in user interfaces to convey to players the nature and consequences of engaging with a particular scheme.

=== Usage ===
This property is primarily used in game UIs to display a description for a scheme, helping players make informed decisions based on the scheme's details.

=== Example of Usage ===
<syntaxhighlight lang="c#">
public class ActiveSchemeManager : MonoBehaviour {
void Start() {
// Iterate through all active schemes of the player and log their descriptions
foreach (Scheme scheme in IM.Player.Schemes) {
Debug.Log($"Scheme description: {scheme.Description}");
}
}
}
</syntaxhighlight>

==== Description ====

* The <code>Start</code> method in the <code>ActiveSchemeManager</code> class demonstrates how to access and log the description of each active scheme associated with the player.

=== Remarks ===

* The <code>Description</code> property is vital in games where strategy and choice are key elements, as it provides players with essential information about their options.
* Accurate and engaging descriptions can significantly enhance player engagement and strategic planning in the game.

Description - Revision history