TerrorNavArea
67 own methods
Navigation areas class
Methods
callable on a TerrorNavArea script handle| Script Function | Returns | Parameters | Description |
|---|---|---|---|
| AddIncomingConnection (ScriptAddIncomingConnection) | void | hscript, int | ( area, dir ) - Add areas that connect TO this area by a ONE-WAY link |
| ComputeDirection (ScriptComputeDirection) | int | Vector | ( point ) - Return direction from this area to the given point |
| ConnectTo (ScriptConnectToArea) | void | hscript, int | ( area, dir ) - Connect this area to given area in given direction |
| ConnectToLadder (ScriptConnectToLadder) | void | hscript | ( ladder, dir ) - Connect this area to given ladder |
| Contains (ScriptContains) | bool | hscript | ( area ) - Return true if other area is on or above this area, but no others |
| ContainsOrigin (ScriptContainsOrigin) | bool | Vector | ( point ) - Return true if given point is on or above this area, but no others |
| DebugDrawFilled (DrawFilled) | void | int, int, int, int, float, bool | Draw area as a filled rect of the given color |
| Disconnect (ScriptDisconnectArea) | void | hscript | ( area ) - Disconnect this area from given area |
| DisconnectLadder (ScriptDisconnectLadder) | void | hscript | ( ladder ) - Disconnect this area from given ladder |
| FindRandomSpot | Vector | none | Get random origin within extent of area |
| GetAdjacentArea (ScriptGetAdjacentArea) | hscript | int, int | ( dir, n ) - Return the i'th adjacent area in the given direction |
| GetAdjacentAreas (ScriptGetAdjacentAreas) | void | int, hscript | ( dir, table ) - Fills a passed in table with all adjacent areas in the given direction |
| GetAdjacentCount (ScriptGetAdjacentCount) | int | int | ( dir ) - Get the number of adjacent areas in the given direction |
| GetAttributes | int | none | Get area attribute bits |
| GetAvoidanceObstacleHeight | float | none | Returns the maximum height of the obstruction above the ground |
| GetCenter | Vector | none | Get center origin of area |
| GetCorner (ScriptGetCorner) | unknown(0x1e) | int | ( corner ) - Get corner origin of area |
| GetDistanceSquaredToPoint | float | Vector | ( pos ) - Return shortest distance between point and this area |
| GetDoor (ScriptGetDoor) | hscript | none | Returns the door entity above the area |
| GetElevator (ScriptGetElevator) | hscript | none | Returns the elevator if in an elevator's path |
| GetElevatorAreas (ScriptGetElevatorAreas) | void | hscript | ( table ) - Fills table with a collection of areas reachable via elevator from this area |
| GetID (ScriptGetID) | int | none | Get area ID. |
| GetIncomingConnections (ScriptGetIncomingConnections) | void | int, hscript | ( dir, table ) - Fills a passed in table with areas connected TO this area by a ONE-WAY link (ie: we have no connection back to them) |
| GetLadders (ScriptGetLadders) | void | int, hscript | ( table ) - Fills a passed in table of ladders in direction |
| GetParent (ScriptGetParent) | hscript | none | Returns the area just prior to this one in the search path |
| GetParentHow (ScriptGetParentHow) | int | none | Returns how we get from parent to us |
| GetPlaceName (ScriptGetPlaceName) | cstring | none | Get place name |
| GetPlayerCount (ScriptGetPlayerCount) | int | int | ( team ) - Return number of players of given team currently within this area (team of zero means any/all) |
| GetRandomAdjacentArea (ScriptGetRandomAdjacentArea) | hscript | int | ( dir ) - Return a random adjacent area in the given direction |
| GetSizeX | float | none | Return the area size along the X axis |
| GetSizeY | float | none | Return the area size along the Y axis |
| GetSpawnAttributes (ScriptGetSpawnAttributes) | int | none | Get spawn attribute bits |
| GetTimeSinceCleared | float | none | Returns the time since the area was cleared |
| GetZ (ScriptGetZ) | float | Vector | ( pos ) - Return Z of area at (x,y) of 'pos' |
| HasAttributes | bool | int | Has area attribute bits |
| HasAvoidanceObstacle | bool | float | ( maxheight ) - Returns true if there's a large, immobile object obstructing this area |
| HasSpawnAttributes (ScriptHasSpawnAttributes) | bool | int | ( attributes ) - Has spawn attribute bits |
| IsBlocked | bool | int, bool | ( team ) - Return true if team is blocked in this area |
| IsBottleneck | bool | none | Returns true if area is a bottleneck |
| IsCleared (ScriptIsCleared) | bool | hscript | ( player ) - Returns true if this area has been cleared for the player |
| IsCompletelyVisibleToTeam | bool | int | ( team ) - Return true if given area is completely visible from somewhere in this area by someone on the team |
| IsConnected (ScriptIsConnectedArea) | bool | hscript, int | ( area, dir ) - Return true if given area is connected in given direction |
| IsConnectedLadder (ScriptIsConnectedLadder) | bool | hscript, int | ( ladder, dir ) - Return true if given area is connected to ladder in given direction |
| IsCoplanar (ScriptIsCoplanar) | bool | hscript | ( area ) - Return true if this area and given area are approximately co-planar |
| IsDamaging | bool | none | Return true if continuous damage (ie: fire) is in this area |
| IsDegenerate | bool | none | Return true if this area is badly formed |
| IsEdge (ScriptIsEdge) | bool | int | ( dir ) - Return true if there are no bi-directional links on the given side |
| IsFlat | bool | none | Return true if this area is approximately flat |
| IsOverlapping (ScriptIsOverlapping) | bool | hscript | ( area ) - Return true if 'area' overlaps our 2D extents |
| IsOverlappingOrigin (ScriptIsOverlappingOrigin) | bool | Vector, float | ( pos, tolerance ) - Return true if 'pos' is within 2D extents of area |
| IsPotentiallyVisibleToTeam | bool | int | ( team ) - Return true if any portion of this area is visible to anyone on the given team |
| IsRoughlySquare | bool | none | Return true if this area is approximately square |
| IsSpawningAllowed | bool | none | Returns true if spawning is allowed |
| IsUnderwater | bool | none | Return true if area is underwater |
| IsVisible (ScriptIsVisible) | bool | Vector | ( point ) - Return true if area is visible from the given eyepoint |
| MarkAreaCleared (ScriptMarkAreaCleared) | void | hscript | ( player ) - Mark this area as cleared for the player |
| MarkAreaNotCleared | void | none | Mark this area as not cleared |
| MarkAsBlocked (ScriptMarkAsBlocked) | void | int | ( team ) - Mark this area as blocked for team |
| MarkAsDamaging | void | float | ( duration ) - Mark this area is damaging for the next 'duration' seconds |
| MarkObstacleToAvoid | void | float | ( height ) - Marks the obstructed status of the nav area |
| RemoveAttributes | void | int | Removes area attribute bits |
| RemoveOrthogonalConnections (ScriptRemoveOrthogonalConnections) | void | int | ( dir ) - Removes all connections in directions to left and right of specified direction |
| RemoveSpawnAttributes (ScriptRemoveSpawnAttributes) | void | int | ( attributes ) - Remove spawn attribute bits |
| SetAttributes | void | int | Set area attribute bits |
| SetPlaceName (ScriptSetPlaceName) | void | cstring | ( name ) - Set place name |
| SetSpawnAttributes (ScriptSetSpawnAttributes) | void | int | ( attributes ) - Set spawn attribute bits |
| UnblockArea (ScriptUnblockArea) | void | none | Unblocks this area |