9 Aug

Docs/Modding/Command_Functions/addNpcRelationship.txt

@@ -0,0 +1,30 @@
+addNpcRelationship(Type, Actor1, Actor2, ..., ActorN)
+
+
+USE:
+Add (or change if a relationship already exists) a relationship between 2 or more NPCs. The list for 'Type' is:
+- Dating (2 actors only)
+- Spouses (2 actors only)
+- Siblings
+- ParentChild (2 actors only, parent is Actor1, child is Actor2)
+- Cousins
+- BossEmployee (2 actors only, Boss is Actor1, employee is Actor2)
+- Colleagues
+
+TYPE: Command, non-Ref
+RETURNS: /
+THEME: NPC-NPC
+COMPARE: removeNPCRelationship, hasRelationship
+
+EXAMPLE:
+    addNpcRelationship(Dating, John, Maria)
+    "John and Maria have started dating. What a matchmaker I was!"
+    "A few months later ..."
+    addNPCRelationship(Spouses, John, Maria) // The 'dating' relationship will be upgraded to spouses
+    
+    Jack:: "Have you met my brother, Jason?"
+    addNpcRelationship(Siblings, Jack, Jason)
+    "A few days later ... in a seperate scene perhaps"
+    Jack:: "Here's my sister, Natalie."
+    addNPCRelationship(Siblings, Jack, Natalie)
+    "The game will now also recognize Jason and Natalie as siblings."

Docs/Modding/Command_Functions/getRelatedPeople.txt

@@ -0,0 +1,25 @@
+getRelatedPeople(Type1, Type2, ..., TypeN)
+
+
+USE:
+Get a group of NPCs with special relationship of specific type or another with each other. The actor variable you give will receive a number suffix starting from 0 when the actors are returned. The list for 'Type' is:
+- Dating
+- Spouses
+- Siblings
+- ParentChild
+- Cousins
+- BossEmployee
+- Colleagues
+This is mostly useful for the 'WHO' conditions of a scene.
+
+TYPE: Command, non-Ref
+RETURNS: Actor
+THEME: NPC-NPC
+COMPARE: getRelatedPerson
+
+EXAMPLE:
+    WHO: Actor = getRelatedPeople(Dating, Spouses); If Actor0:attractiveness > 70 && Actor1:attractiveness > 70
+    // Find a couple who are both hot
+    
+    WHO: Actor = getRelatedPeople(Siblings); If Actor2.isValid()
+    // Find a family with at least 3 siblings

Docs/Modding/Command_Functions/getRelatedPerson.txt

@@ -0,0 +1,30 @@
+Actor.getRelatedPerson(Type1, Type2, ..., TypeN)
+
+
+USE:
+Get a single NPC with a relationship of the specified type or another with the specified NPC. The list for 'Type' is:
+- Dating
+- Spouses
+- Siblings
+- ParentChild
+- Cousins
+- BossEmployee
+- Colleagues
+
+TYPE: Command, non-Ref
+RETURNS: Actor
+THEME: NPC-NPC
+COMPARE: getRelatedPeople
+
+EXAMPLE:
+    WHO: Dating = getSpecific(Dating); InLaw = Dating.getRelatedPerson(ParentChild)
+    // For a scene related to the in laws perhaps
+    
+    JohnsSO = John.getRelatedPerson(Spouses, Dating)  
+    If JohnsSO.isValid()
+        JohnsSO.show(3)
+        JohnsSO.dress()
+        "John's sweetheart arrives. We can swing now!"
+    Else
+        "John is single."
+    Endif

Docs/Modding/Command_Functions/matchLastName.txt

@@ -0,0 +1,13 @@
+Actor.matchLastName(Actor2)
+
+USE:
+Change Actor's last name to match that of Actor2
+
+TYPE: Command, Non-Ref
+RETURNS: /
+THEME: NPC-NPC
+COMPARE: 
+
+EXAMPLE:
+    Eli.matchLastName(Jack)
+    "Eli just got married. She took her husband Jack's last name"

Docs/Modding/Command_Functions/removeNpcRelationship.txt

@@ -0,0 +1,18 @@
+removeNpcRelationship(Actor1, Actor2, ..., ActorN)
+
+
+USE:
+Remove any relationships between 2 or more NPCs.
+
+TYPE: Command, non-Ref
+RETURNS: /
+THEME: NPC-NPC
+COMPARE: addNPCRelationship, hasRelationship
+
+EXAMPLE:
+    addNpcRelationship(Dating, John, Maria)
+    "John and Maria have started dating. What a matchmaker I was!"
+
+    "A few months later ..."
+    removeNpcRelationship(John, Maria)
+    "Oh no, they broke up ..."

Docs/Modding/Condition_Functions/hasRelationship.txt

@@ -0,0 +1,23 @@
+Actor.hasRelationship(Type1, Type2, ..., TypeN)
+
+USE:
+Checks to see if this NPC is already in a special relationship of a specific type or another with any another NPC. The list for 'Type':
+- Dating
+- Spouses
+- Siblings
+- ParentChild
+- Cousins
+- BossEmployee
+- Colleagues
+
+TYPE: Condition, non-Ref
+RETURNS: bool
+THEME: NPC-NPC
+COMPARE: addNPCRelationship, removeNPCRelationship
+
+EXAMPLE:
+    If John.hasRelationship(Dating, Spouses)  || John.isDating()
+        "John is taken, ladies ..."
+    Else
+        "John is available, ladies!"
+    Endif