Tayfunwiki: Created page with "== `Icon` Property in Scheme Class == === Overview === The `Icon` property in the Scheme class holds a visual icon associated with the scheme, providing a graphical representation that reflects its theme or action. === Property Definition === [field: SerializeField] public Sprite Icon { get; private set; } === Description === * Type: `Sprite` - Used in Unity for 2D images. * Accessibility..."

2024-01-04T23:05:31Z

Created page with "== <code>Icon</code> Property in Scheme Class == === Overview === The <code>Icon</code> property in the Scheme class holds a visual icon associated with the scheme, providing a graphical representation that reflects its theme or action. === Property Definition === <syntaxhighlight lang="c#"> [field: SerializeField] public Sprite Icon { get; private set; } </syntaxhighlight> === Description === * Type: <code>Sprite</code> - Used in Unity for 2D images. * Accessibility..."

New page

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

=== Overview ===
The <code>Icon</code> property in the Scheme class holds a visual icon associated with the scheme, providing a graphical representation that reflects its theme or action.

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

=== Description ===

* Type: <code>Sprite</code> - Used in Unity for 2D images.
* Accessibility: Publicly readable, but can only be set within the class.

=== Functionality ===

* The <code>Icon</code> serves as a visual identifier, making it easier for players to recognize and understand the scheme's purpose.
* It enhances user interfaces by visually representing schemes in menus, dialogues, or other interactive elements.

=== Usage ===
The <code>Icon</code> property is used in game UIs to display an icon for a scheme. The Scheme objects themselves are not directly editable in the Unity Inspector, but their properties, including <code>Icon</code>, can be accessed and manipulated programmatically.

=== Example of Usage ===
<syntaxhighlight lang="c#">
public class SchemeUIManager : MonoBehaviour {
public Image schemeIconImage;

void Start() {
// Retrieve a specific scheme by its name
Scheme currentScheme = IM.Player.GetScheme("Assassination");

if (currentScheme != null && schemeIconImage != null) {
// Set the icon of the retrieved scheme in an Image component
schemeIconImage.sprite = currentScheme.Icon;
schemeIconImage.gameObject.SetActive(true);
}
}
}
</syntaxhighlight>

==== Description ====

* The <code>Start</code> method in the <code>SchemeUIManager</code> class demonstrates retrieving a specific scheme by name using <code>IM.Player.GetScheme</code> and then using its <code>Icon</code> property to display the scheme's icon in a UI element.

=== Remarks ===

* The <code>Icon</code> property is key to providing intuitive visual cues in game interfaces, especially in games where schemes are a major gameplay element.
* This approach is beneficial in strategy or role-playing games where visual storytelling and player interaction with various schemes are crucial.

Icon - Revision history