Role.SetDescription

Role Class - SetDescription Method

Overview

The SetDescription method in the Role class is used to update the description of a specific role.

Syntax

public void SetDescription(string description)

Description

This method modifies the description of a role. The description parameter is a string that defines the new description for the role.

Usage

Use this method to change the description of a role dynamically during the game. It's useful for providing more detailed or context-specific information about a role.

Example of Usage

public class RoleManager : MonoBehaviour {
    void UpdateRoleDescription() {
        // Retrieve a specific role, e.g., "Leader"
        var role = IM.GetRole("Leader");

        // Update the description of the role
        role.SetDescription("A leader with ultimate authority");
    }
}

Remarks

• Updating a role's description can help players better understand the role's significance and responsibilities within the game.
• It's important to keep descriptions clear and concise for better player comprehension.