2.18

Docs/Modding/Command_Functions/floor.txt

@@ -0,0 +1,21 @@
+{float variable}.floor()
+
+USE: 
+Use this function to get the integer value of a float variable.
+Any value less than x.3 / x.5 / x.8 will be rounded down to "x".
+
+TYPE: Command, Non-Ref (ref-like syntax)
+RETURNS: float variable
+THEME: Math
+COMPARE: round()
+
+EXAMPLE:
+    val = 1.4
+    rv = val.round()
+    fv = val.floor()
+    "Val = <rv>, <fv>"  // Will output 'Val = 1, 1'
+    
+    val = 1.5
+    rv = val.round()
+    fv = val.floor()
+    "Val = <rv>, <fv>"  // Will output 'Val = 2, 1'

Docs/Modding/Command_Functions/getActorVar.txt

@@ -0,0 +1,23 @@
+{Actor}.getActorVar(name)
+
+USE: 
+Use this function to get the float value of a variable from a certain actor. 
+The actor can be the Player or any other actor.
+
+This function also allows testing it a certain TAG is assigned to an actors.
+
+If a tag / value was not assigned the function will return 0.
+
+
+TYPE: Command, Non-Ref (ref-like syntax)
+RETURNS: variable value
+THEME: Variables
+COMPARE: getActorVar, modifyActorVar
+
+EXAMPLE:
+    Player.setActorVar(tag_Player, 1) // Set the Tag 'Player' to the Player's character
+    Player.setActorVar(tag_Player, -1) // Remove the Tag 'Player' from the Player's character
+    
+    Player.setActorVar(SomeVariable, 42)     // Set the variable to 42
+    val = Player.getActorVar(SomeVariable)
+    "The value of SomeVariable is <val>."

Docs/Modding/Command_Functions/getPerson.txt

@@ -1,7 +1,26 @@
-getPerson(optional bool)
+getPerson(optional bool/tag)
 
 USE:
-Get a random person in your current game (i.e. could be anyone that has been created with GeneratePerson() or GeneratePersonTemporary() then MakePermanent() ). Optional bool parameters to filter for whether their contact has been exchanged to you or not.
+
+Get a random person in your current game (i.e. could be anyone that has 
+been created with GeneratePerson() or GeneratePersonTemporary() then 
+MakePermanent() ). 
+
+Optional parameters:
+
+Boolean (true/false): to filter for whether their contact has been exchanged 
+to you or not.
+
+Tag (any): to filter for persons that have the given tag assigned.
+The tag command was introduced with LifePlay 2.18 and can be used to iterate over 
+all persons with a certain tag.
+
+getPerson() will only return a specific person once for a scene. So you can use it to 
+iterate though all persons in the game (omit the parameter), all you have in your 
+contacts (set parameter to true), all persons you don't have exchanged contacts 
+with (set to false) or all persons with a specific tag.
+
+
 
 TYPE: Command, Non-Ref
 RETURNS: Actor
@@ -10,5 +29,14 @@ COMPARE: getSpecific
 
 EXAMPLE:
     Actor = getPerson()  // get anyone
-    Actor = getPerson(true) // get someone who has exchanged numbers with me
+    Actor = getPerson(true) // get someone who has exchanged contacts with me
-    Actor = getPerson(false)  // get someone whose number I don't have
+    Actor = getPerson(false)  // get someone who is not in my contacts
+    Actor = getPersone(SomeTag) // get only persons with 'SomeTag' (in contacts or not)
+    
+    Actor = getPerson(TagModel)
+    While Actor.isValid()
+        // Do something with the model
+        
+        // Get the next one or an invalid actor if no more persons with this tag.
+        Actor = getPerson(TagModel)
+    EndWhile

Docs/Modding/Command_Functions/modifyActorVar.txt

@@ -0,0 +1,22 @@
+{Actor}.modifyActorVar(name, value)
+
+USE: 
+Use this function to modify the float value of a variable by a given value. 
+The actor can be the Player or any other actor.
+
+This function was introduced with LifePlay 2.18.
+
+TYPE: Command, Non-Ref (ref-like syntax)
+RETURNS: /
+THEME: Variables
+COMPARE: getActorVar, modifyActorVar
+
+EXAMPLE:
+    Player.setActorVar(SomeVariable, 42)     // Set the variable to 42
+    Player.modifyActorVar(SomeVariable, 1)
+    val = Player.getActorVar(SomeVariable)
+    "The value of SomeVariable is <val>."   // Will be 43
+    
+    Player.modifyActorVar(SomeVariable, -30)
+    val = Player.getActorVar(SomeVariable)
+    "The value of SomeVariable is <val>."   // Will be 13

Docs/Modding/Command_Functions/passTime.txt

@@ -1,7 +1,7 @@
 passTime(hours_min, hours_max)
 
 USE:
-I initially intended this as a way to pass time during a scene, but it turned out too complicated due to stat depreciations. All it does now is add to the variable TimePassed, which can be useful for while loop I guess.
+Use to pass time during a scene.
 
 TYPE: Command, Non-Ref
 RETURNS: /

Docs/Modding/Command_Functions/round.txt

@@ -0,0 +1,22 @@
+{float variable}.round()
+
+USE: 
+Use this function mathematically round a float variable.
+Any value less than x.5 will be rounded down to "x" anything larger or equal to 
+x.5 will be rounded up to x+1.
+
+TYPE: Command, Non-Ref (ref-like syntax)
+RETURNS: float variable
+THEME: Math
+COMPARE: floor()
+
+EXAMPLE:
+    val = 1.4
+    rv = val.round()
+    fv = val.floor()
+    "Val = <rv>, <fv>"  // Will output 'Val = 1, 1'
+    
+    val = 1.5
+    rv = val.round()
+    fv = val.floor()
+    "Val = <rv>, <fv>"  // Will output 'Val = 2, 1'

Docs/Modding/Command_Functions/selectNPC.txt

@@ -1,7 +1,18 @@
-selectNPC()
+selectNPC(optional tag)
 
 USE:
-Choose a person from your contacts by leaving the scene temporarily and opening the Contacts menu. Must be followed by getSelectedNPC(). Basically superior to chooseContact() unless you really don't want to take the player out of the scene even temporarily.
+Choose a person from your contacts by leaving the scene temporarily and 
+opening the Contacts menu. Must be followed by getSelectedNPC(). 
+Basically superior to chooseContact() unless you really don't want to take 
+the player out of the scene even temporarily.
+
+Optional parameter:
+
+Tag (any): to filter for persons that have the given tag assigned.
+The tag command was introduced with LifePlay 2.17 and can be used to filter the contact
+list by a certain tag. (The player can not modify this query, so you force him to pick a
+person that has this tag, or none.)
+
 
 TYPE: Command, Non-Ref
 RETURNS: /

Docs/Modding/Command_Functions/setActorVar.txt

@@ -0,0 +1,21 @@
+{Actor}.setActorVar(name, value)
+
+USE: 
+Use this function to set a float variable to a certain actor. 
+The actor can be the Player or any other actor.
+
+This function also allows setting TAGs to actors.
+
+TYPE: Command, Non-Ref (ref-like syntax)
+RETURNS: /
+THEME: Variables
+COMPARE: getActorVar, modifyActorVar
+
+EXAMPLE:
+    Player.setActorVar(tag_Player, 1) // Set the Tag 'Player' to the Player's character
+    Player.setActorVar(tag_Player, -1) // Remove the Tag 'Player' from the Player's character
+    
+    MainActor = getPerson(true)
+    MainActor.setActorVar(SomeVariable, 42)     // Set the variable to 42
+    val = MainActor.getActorVar(SomeVariable)
+    "The value of SomeVariable is <val>."

Docs/Modding/Command_Functions/setBackground3D.txt

@@ -0,0 +1,21 @@
+setBackground3D(relative/path/to/3d-scene.lpworld)
+
+USE:
+Set the background as a 3D room for the current scene.
+
+HINT: 
+Call "setBackground" before setBackground3D() to: 
+a) Handle non existing rooms
+b) Give the dress() function a clue, how to dress the actors!
+
+TYPE: Command, non-Ref
+RETURNS: /
+THEME: Scenes, Location
+COMPARE: sceneStart, dress, setBackground
+
+EXAMPLE:
+    
+    setBackground(work)
+    setBackground3D(Modules/nn_PornEmpire/Rooms/nn_pe_office_1.lpworld)
+    Player.dress()      // Player will be in a 3D room if PornEmpire mod is installed and wear office clothing
+    Player.show()