Difference between revisions of "GetEnteringObject"

From NWN Lexicon
Jump to: navigation, search
(Created page with "=GetEnteringObject()= Gets the object that last opened or entered the calling object. object  GetEnteringObject(); ====Description==== Returns the o...")
 
Line 3: Line 3:
 
Gets the object that last opened or entered the calling object.
 
Gets the object that last opened or entered the calling object.
  
 +
<nwscript>
 
  [[object | object ]] GetEnteringObject();
 
  [[object | object ]] GetEnteringObject();
 +
</nwscript>
  
 
====Description====
 
====Description====
Line 17: Line 19:
 
====Example====
 
====Example====
  
<font color="#007f00">// Greet any Players that come into a trigger set around a drunk in a tavern.
+
<nwscript>
  </font>
+
// Greet any Players that come into a trigger set around a drunk in a tavern.
  <font color="#0000ff">void</font> main()
+
   
 +
  void main()
 
  {
 
  {
     <font color="#0000ff">if</font>(GetIsPC(GetEnteringObject()))
+
     if(GetIsPC(GetEnteringObject()))
 
     {
 
     {
         AssignCommand(GetNearestObjectByTag(<font color="#00007f">"TavernPatron"</font>),SpeakOneLinerConversation(<font color="#00007f">"DrunkGreeting"</font>));
+
         AssignCommand(GetNearestObjectByTag("TavernPatron"),SpeakOneLinerConversation("DrunkGreeting"));
         AssignCommand(GetNearestObjectByTag(<font color="#00007f">"TavernPatron"</font>),ActionPlayAnimation(ANIMATION_LOOPING_PAUSE_DRUNK));
+
         AssignCommand(GetNearestObjectByTag("TavernPatron"),ActionPlayAnimation(ANIMATION_LOOPING_PAUSE_DRUNK));
 
     }
 
     }
 
  }
 
  }
 +
</nwscript>
  
 
====See Also====
 
====See Also====

Revision as of 20:39, 25 August 2012

GetEnteringObject()

Gets the object that last opened or entered the calling object.

Description

Returns the object that last opened or entered the calling object.
The value returned by this function depends on the object type of the caller: (1) If the caller is a door or placeable it returns the object that last triggered it. (2) If the caller is a trigger, area of effect, module, area or encounter it returns the object that last entered it.
Return value on error: OBJECT_INVALID.



Version

1.22

Example

 // Greet any Players that come into a trigger set around a drunk in a tavern.
 
 void main()
 {
     if(GetIsPC(GetEnteringObject()))
     {
         AssignCommand(GetNearestObjectByTag("TavernPatron"),SpeakOneLinerConversation("DrunkGreeting"));
         AssignCommand(GetNearestObjectByTag("TavernPatron"),ActionPlayAnimation(ANIMATION_LOOPING_PAUSE_DRUNK));
     }
 }

See Also

functions: 

GetExitingObject

events: 

OnUsed Event



 author: John Shuell, editor: Kristian Markon