Culture Creation Documentation

Overview

The Culture class provides a method to create and manage cultural identities with specific attributes. This documentation focuses on the Create method, explaining its usage, parameters, return types, and provides an example implementation for creating a culture.

Create Method

Description

Creates a new culture with specified attributes and integrates it into the system. This method ensures that each culture is unique within the system and properly managed.

Signature

public static Culture Create(string cultureName, string description, Sprite icon = null, IEnumerable<string> femaleNames = null, IEnumerable<string> maleNames = null)

Parameters

cultureName (string): The name of the culture.
description (string): A brief description of the culture.
icon (Sprite, optional): A visual representation (icon) of the culture.
femaleNames (IEnumerable<string>, optional): A collection of common female names within the culture.
maleNames (IEnumerable<string>, optional): A collection of common male names within the culture.

Returns

If a culture with the same name exists, it returns the existing culture; otherwise, it creates and returns a new culture.

Example Usage

using Nullframes.Intrigues;
using UnityEngine;

public class Runtime : MonoBehaviour {
    public Sprite icon;

    private void Start() {
        CreateNewCulture();
    }

    private void CreateNewCulture() {
        Culture newCulture = Culture.Create("Varag", "Description", icon,
            new[] { "Eleanor", "Isabella", "Margaret", "Matilda", "Beatrice" },
            new[] { "William", "Henry", "Richard", "Edward", "Geoffrey" });
        
        IM.Player.SetCulture(newCulture);
    }
}

Remarks

Uniqueness Check: The method checks for the existence of a culture with the provided name to ensure uniqueness. If an existing culture is found, it logs a debug message and returns the existing culture to prevent duplication.
Culture Attributes: The method allows for a flexible definition of a culture, including visual representation and gender-specific names, which can be used to enrich the cultural context within the system.
Error Handling: It is advisable to implement error handling for scenarios where the culture creation process might encounter issues, such as missing attributes or system integration failures.
System Integration: Once a culture is created, it can be integrated into various parts of the system, such as character creation, storytelling elements, or any other feature that requires cultural context.