C# Class Aura.Channel.World.Location

Representation of a location in the world.
Used to save locations, ie a location to warp back to.
Mostra file Open project: aura-project/aura Class Usage Examples

Public Properties

Property Type Description
RegionId int
X int

Public Methods

Method Description
Equals ( object obj ) : bool
GetHashCode ( ) : int
Location ( int regionId, Position pos ) : Aura.Data

Creates new Location based on region id and position.
Location ( int regionId, int x, int y ) : Aura.Data

Creates new Location based on region id and coordinates.
Location ( long locationId ) : Aura.Data

New Location based on location id (i.e. 0x3000RRRRXXXXYYYY).
Location ( string location ) : Aura.Data

Creates new location based on "client path". E.g. "Ula_DgnHall_Runda_after/_Ula_DgnHall_Runda_after"

Officials use "paths" to describe locations in some cases, based on the world files. "MapName/Area/Event", etc. The coordinates are the center of the element for regions and areas and the actual coordinates of the event for events.

ToLocationId ( ) : long

Returns location id (i.e. 0x3000RRRRXXXXYYYY).
ToString ( ) : string

Returns a string representing this Location.
operator ( ) : bool

Method Details

Equals() public method

public Equals ( object obj ) : bool
obj object
return bool

GetHashCode() public method

public GetHashCode ( ) : int
return int

Location() public method

Creates new Location based on region id and position.
public Location ( int regionId, Position pos ) : Aura.Data
regionId int
pos Position
return Aura.Data

Location() public method

Creates new Location based on region id and coordinates.
public Location ( int regionId, int x, int y ) : Aura.Data
regionId int
x int
y int
return Aura.Data

Location() public method

New Location based on location id (i.e. 0x3000RRRRXXXXYYYY).
public Location ( long locationId ) : Aura.Data
locationId long
return Aura.Data

Location() public method

Creates new location based on "client path". E.g. "Ula_DgnHall_Runda_after/_Ula_DgnHall_Runda_after"
Officials use "paths" to describe locations in some cases, based on the world files. "MapName/Area/Event", etc. The coordinates are the center of the element for regions and areas and the actual coordinates of the event for events.
Invalid location. Region, area, or event not found.
public Location ( string location ) : Aura.Data
location string
return Aura.Data

ToLocationId() public method

Returns location id (i.e. 0x3000RRRRXXXXYYYY).
public ToLocationId ( ) : long
return long

ToString() public method

Returns a string representing this Location.
public ToString ( ) : string
return string

operator() public static method

public static operator ( ) : bool
return bool

Property Details

RegionId public_oe property

public int RegionId
return int

X public_oe property

public int X
return int