Класс Location

Локация. Подробнее...

Открытые члены
uint16	GetProtoId ()
	Позволяет получить номер прототипа локации. Подробнее...
uint	GetMapCount ()
	Позволяет узнать число карт в локации. Подробнее...
Map	GetMap (uint16 mapPid)
	Позволяет получить по прототипу карту, находящуюся в локации. Подробнее...
Map	GetMapByIndex (uint index)
	Позволяет получить карту в локации по индексу. Подробнее...
uint	GetMaps (Map @[]@+maps)
	Позволяет получить все карты в локации. Подробнее...
bool	Reload ()
	Переинициализирует все карты в локации. Подробнее...
void	Save (bool withMaps)
	Сохраняет данные локации и, опционально, всех её карт. Подробнее...
void	Update ()
	Обновляет информацию о локации на стороне клиентов. Подробнее...

Открытые атрибуты
const uint	Id
	Идентификатор локации. Подробнее...
uint	Color
	Задает цвет локации. Подробнее...
const bool	IsNotValid
	Позволяет определить валидность объекта. Подробнее...
uint16	WorldX
	Позиция X на глобальной карте. Подробнее...
uint16	WorldY
	Позиция Y на глобальной карте. Подробнее...
bool	Visible
	Видна ли локация на глобальной карте мира. Подробнее...
bool	GeckEnabled
	Влияют ли на видимость локации расположенные в ней предметы с флагом ITEM_GECK. Подробнее...
int	GeckCount
	Количество предеметов с флагом ITEM_GECK в локации. Подробнее...
uint8	Radius
	Радиус локации. Подробнее...
bool	AutoGarbage
	Удалять ли карту, когда на ней не осталось ни одного игрока, местного NPC или предмета с флагом ITEM_GECK. Подробнее...

Подробное описание

Локация.

Локации – это кружки на глобальной карте мире, отмечающие определенные места. Каждая локация может содержать множество карт. Информация о локациях содержится в файле CITY.TXT.

См. также

Map

Методы

uint16 GetProtoId

(

)

Позволяет получить номер прототипа локации.

Возвращает

Номер прототипа локации.

uint GetMapCount

(

)

Позволяет узнать число карт в локации.

Возвращает

Число карт в локации.

Map GetMap

(

uint16

mapPid

)

Позволяет получить по прототипу карту, находящуюся в локации.

Аргументы

mapPid

Номер прототипа карты.

Возвращает

Указатель на карту.

Map GetMapByIndex

(

uint

index

)

Позволяет получить карту в локации по индексу.

Порядок карт прописывается в CITY.TXT с помощью параметра map_(X).

Аргументы

index

Индекс карты.

Возвращает

Указатель на карту.

uint GetMaps

(

Map @@+[]

maps

)

Позволяет получить все карты в локации.

Аргументы

maps	Массив карт, к которому будут добавлены все найденные карты.

Возвращает

Количество карт в локации.

bool Reload

(

)

Переинициализирует все карты в локации.

Возвращает

true – в случае успеха, false – в случае неудачи.

void Save

(

bool

withMaps

)

Сохраняет данные локации и, опционально, всех её карт.

Аргументы

withMaps

Указывает, нужно ли сохранять данные карт локации (true) или нет (false).

void Update

(

)

Обновляет информацию о локации на стороне клиентов.

Если функция не будет вызвана, то информация о локации обновится при релогине или повторном выходе на глобальную карту клиента.

Данные класса

const uint Id

Идентификатор локации.

uint Color

Задает цвет локации.

По-умолчанию равно 0, клиент берет значение - 0x3C00FF00.

Заметки

Функции и макросы для работы с цветом определены в _colors.fos.

const bool IsNotValid

Позволяет определить валидность объекта.

uint16 WorldX

Позиция X на глобальной карте.

uint16 WorldY

Позиция Y на глобальной карте.

bool Visible

Видна ли локация на глобальной карте мира.

bool GeckEnabled

Влияют ли на видимость локации расположенные в ней предметы с флагом ITEM_GECK.

При значении true, в случае, если количество таких предметов больше нуля, локация приобретает свойство, аналогичное Visible.

int GeckCount

Количество предеметов с флагом ITEM_GECK в локации.

uint8 Radius

Радиус локации.

bool AutoGarbage

Удалять ли карту, когда на ней не осталось ни одного игрока, местного NPC или предмета с флагом ITEM_GECK.

Актуально при geck_visible == 1.