ExploreAreaForPlayer(object, object)

Reveals the entire map of an area to a player.

void ExploreAreaForPlayer(
    object oArea,
    object oPlayer
);

Parameters

oArea

The map of an area to reveal.

oPlayer

The player to reveal the area map to.


Description

Reveals the entire map of oArea to oPlayer.



Remarks

Once an area on the map has been revealed, there is no way to hide it again.


Version

1.22

Example

// if this code were placed in the OnEnter event
// of an area, the entire map would be revealed to the player
// even if they have never been there before.

void main()
{
   object oPlayer = GetEnteringObject();
   if (GetIsObjectValid(oPlayer) && GetIsPC(oPlayer))
   {
      object oArea = GetArea(oPlayer); 
      ExploreAreaForPlayer(oArea, oPlayer);
   }
}

See Also

categories: Area Functions


 author: Brett Lathrope, editor: Charles Feduke
 Send comments on this topic.