Tayfunwiki: Created page with "= Family Creation = == Overview == The `Family` class provides methods to create and manage families with specific attributes. This documentation explains how to use the `Create` method, detailing its parameters, return types, and providing example implementations for creating families. == Create Method Variants == The `Create` method has two variants, each designed to accommodate different scenarios for specifying family attributes, su..."

2024-03-03T11:35:28Z

Created page with "= Family Creation = == Overview == The <code>Family</code> class provides methods to create and manage families with specific attributes. This documentation explains how to use the <code>Create</code> method, detailing its parameters, return types, and providing example implementations for creating families. == Create Method Variants == The <code>Create</code> method has two variants, each designed to accommodate different scenarios for specifying family attributes, su..."

New page

= Family Creation =

== Overview ==
The <code>Family</code> class provides methods to create and manage families with specific attributes. This documentation explains how to use the <code>Create</code> method, detailing its parameters, return types, and providing example implementations for creating families.

== Create Method Variants ==
The <code>Create</code> method has two variants, each designed to accommodate different scenarios for specifying family attributes, such as culture.

=== Variant 1: Create with Direct Object References ===

==== Description ====
Creates a new family with specific attributes using direct object references for the culture. It is the preferred method when you have a direct reference to the culture object.

==== Signature ====
<syntaxhighlight lang="c#">
public static Family Create(string familyName, string description, Culture culture = null, Sprite icon = null)
</syntaxhighlight>

==== Parameters ====

* <code>familyName</code> (string): The name of the family.
* <code>description</code> (string): A description of the family's history, values, or notable characteristics.
* <code>culture</code> (Culture, optional): The culture associated with the family.
* <code>icon</code> (Sprite, optional): A visual representation (banner) of the family.

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

==== Example Usage ====
<syntaxhighlight lang="c#">
using Nullframes.Intrigues;
using UnityEngine;

public class Runtime : MonoBehaviour {

public Sprite icon;

private void Start() {
CreatePlayerFamily();
}

public void CreatePlayerFamily() {
Family family = Family.Create("Frostborn", "Description", IM.Player.Culture, icon);

IM.Player.JoinFamily(family);
}
}
</syntaxhighlight>

=== Variant 2: Create with Culture by Name or ID ===

==== Description ====
Facilitates family creation using the name or ID for culture instead of a direct object reference. This method is useful when you prefer to reference culture by an identifier.

==== Signature ====
<syntaxhighlight lang="c#">
public static Family Create(string familyName, string description, string cultureNameOrId, Sprite icon)
</syntaxhighlight>

==== Parameters ====

* <code>familyName</code> (string): The name of the family.
* <code>description</code> (string): A description of the family's history, values, or notable characteristics.
* <code>cultureNameOrId</code> (string): The name or ID of the culture associated with the family.
* <code>icon</code> (Sprite): A visual representation (banner) of the family.

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

==== Example Usage ====
<syntaxhighlight lang="c#">
using Nullframes.Intrigues;
using UnityEngine;

public class Runtime : MonoBehaviour {

public Sprite icon;

private void Start() {
CreatePlayerFamily();
}

public void CreatePlayerFamily() {
Family family = Family.Create("Frostborn", "Description", "Varag", icon);

IM.Player.JoinFamily(family);
}
}
</syntaxhighlight>

== Remarks ==

* Uniqueness Check: Both method variants check for the existence of a family with the provided name to ensure uniqueness. If an existing family is found, it returns the existing family to prevent duplication.
* Debug Logging: A debug message is logged if an attempt is made to create a family with a name that already exists within the system. This aids in debugging and maintaining the integrity of the family system.
* Culture Validation: For the second variant, where culture is specified by name or ID, the method includes validation to ensure the specified culture exists within the system before creating the family.
* Error Handling: Implementing error handling around the <code>Create</code> method is recommended, especially for the second variant, to deal with scenarios where the specified culture does not exist.

Family:Create - Revision history