GetEnteringObject()

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

object GetEnteringObject();

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:	GetClickingObject | GetExitingObject
categories:	Action on Object Functions | Area Functions | Encounter Functions | Module Functions | Spells Functions | Traps Functions
events:	OnClientEnter Event | OnEnter Event | OnOpen Event | OnUsed Event

---

 author: John Shuell, editor: Kristian Markon