Return Clan Node
π Return Clan Node
The Return Clan node allows you to dynamically fetch a Clan object through a method defined in your C# code and pass that family into the next node in the execution chain.
π§ What it does
When this node is executed, it calls the C# method you specified via the dropdown (auto-populated from methods marked with the [GetClan] attribute returning Clan).
If a valid family is returned, it will be passed forward to the connected nodes using the [Clan] port.
π Example Use Case
Check if the Clan's honor is below 50:
Execution Flow:
Startnode runsReturn Clan: King's Familyis called β calls the method below- The returned
Clanis passed intoGet [Clan] Variable - If the value is below 50, a log is triggered
βοΈ Method Signature
To appear in the dropdown, your method must:
[GetClan("Your Custom Name")]
private Family YourMethodName(Scheme scheme)
- The method must return a
Clan - Must accept only a
Schemeparameter - Must be marked with the
[GetClan]attribute
Demo Example:
[GetClan("Find Clan")]
private Family FindClan(Scheme scheme) {
return conspirator.Clan;
}
This example can be found in the Demo_Methods.cs file.
β Output
- [Clan] β Passes the returned clan to the next node
- [Null] β Triggered if method returns null
π Tips
- This node is useful when you want to inspect, compare, or manipulate specific clans that aren't directly linked to the current actor.
- Use together with Get Clan Variable or Set Clan Variable nodes for rich logic.
π Related Nodes
Get Clan VariableSet Clan VariableReturn ClanReturn Actor
Still unsure? Check the Demo_Schemes folder for working examples.