View source for Policy.Icon

=== Policy Class - <code>Icon</code> Property ===

==== Overview ====
The <code>Icon</code> property in the Policy class represents the visual symbol or graphic associated with a specific policy, like "Economy."

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

==== Description ====
This property holds a <code>Sprite</code> object which serves as the icon for the policy. It can be used in the game's user interface to visually represent the policy.

==== Usage ====
The <code>Icon</code> property is typically used to display an image or icon in the game's UI, helping players to quickly identify the policy.

==== Example of Usage ====
<syntaxhighlight lang="c#">
public class PolicyDisplay : MonoBehaviour {
    private Policy currentPolicy;
    public Image policyIconDisplay; // Reference to a UI Image component

    void Start() {
        // Fetching the 'Economy' policy from the game's policy manager
        currentPolicy = IM.GetPolicy("Economy");

        if (currentPolicy != null && policyIconDisplay != null) {
            // Setting the UI Image to the policy's icon
            policyIconDisplay.sprite = currentPolicy.Icon;
        }
    }
}
</syntaxhighlight>

==== Remarks ====

* The <code>Icon</code> property is accessed from a <code>Policy</code> object, retrieved through the <code>IM.GetPolicy</code> method.
* This property is essential for visually representing policies in the game's UI, enhancing player understanding and engagement.
* Ensure that the UI component (like <code>Image</code>) is properly referenced in the script to display the icon correctly.