Portrait - Revision history

Tayfunwiki: Created page with "== `Portrait` Property in Actor Class == === Overview === The `Portrait` property in the `Actor` class is used to represent the visual depiction or image of the actor. This property is crucial for providing a graphical representation of the actor in the game's user interface. === Syntax === public Sprite Portrait { get; protected set; } === Description === * Property Type: Sprite 2023-12-22T11:57:58Z Created page with "== <code>Portrait</code> Property in Actor Class == === Overview === The <code>Portrait</code> property in the <code>Actor</code> class is used to represent the visual depiction or image of the actor. This property is crucial for providing a graphical representation of the actor in the game's user interface. === Syntax === <syntaxhighlight lang="c#"> public Sprite Portrait { get; protected set; } </syntaxhighlight> === Description === * Property Type: <code>Sprite</c..." New page == <code>Portrait</code> Property in Actor Class == === Overview === The <code>Portrait</code> property in the <code>Actor</code> class is used to represent the visual depiction or image of the actor. This property is crucial for providing a graphical representation of the actor in the game's user interface. === Syntax === <syntaxhighlight lang="c#"> public Sprite Portrait { get; protected set; } </syntaxhighlight> === Description === * Property Type: <code>Sprite</code>. The <code>Portrait</code> property is of the type <code>Sprite</code>, which is a class in Unity used for creating 2D and UI images. * Accessibility: The property is publicly readable, allowing other parts of the code to access the actor's portrait. The <code>protected set</code> modifier ensures that the portrait can only be modified within the <code>Actor</code> class or its subclasses, maintaining controlled management of the actor's visual representation. === Purpose === The <code>Portrait</code> property is essential for visually representing the actor within the game, particularly in user interfaces like character menus, dialogue boxes, or inventory screens. It helps players to identify and connect with the character. === Usage === This property is used to access and display the actor's portrait. It can be a key factor in user interface design and player engagement, providing a visual reference for the character. ==== Example: ==== <syntaxhighlight lang="c#"> Sprite actorPortrait = someActor.Portrait; // Use actorPortrait to display the actor's image in the game's UI </syntaxhighlight>In this example, the actor's portrait is accessed and can be used in various parts of the game's user interface for visual representation. === Remarks === * The use of <code>Sprite</code> as the property type aligns with Unity's framework for handling 2D graphics, ensuring compatibility and ease of use within the Unity engine. * The <code>protected set</code> access level ensures the integrity of the actor's portrait, preventing it from being changed arbitrarily, which is important for maintaining consistent visual representation throughout the game. * The <code>Portrait</code> property enhances the game's visual storytelling and aids in creating an immersive and engaging player experience.