Entity
Entity class — это базовый тип для объектов мира, отслеживаемых игрой.
Примечание
На этой странице документируются члены, объявленные непосредственно на Entity. Унаследованные члены доступны из MemoryAccessor.
Статические методы
static GetClassNameStatic()string
Получает статическое имя класса.
Возвращает:
- string — Статическое имя запрошенного класса.
Методы
GetIndex()number
Получает индекс.
Возвращает:
- number - Запрошенный индекс.
GetHandle()number
Получает дескриптор.
Возвращает:
- number - Запрошенный дескриптор.
GetGameSceneNode()DataView | null
Получает узел игровой сцены.
Возвращает:
- DataView | null - Соответствующий объект или
nullесли он недоступен.
GetInheritance()string[]
Возвращает наследство.
Возвращает:
- string[] - Массив с совпадающими значениями.
GetClassName()string
Получает имя класса.
Возвращает:
- string - Запрошенное имя класса.
InheritFrom(className: string)boolean
Проверяет, наследуется ли сущность от указанного имени класса.
classNamestring — Имя класса для проверки или запроса.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
GetHealth()number
Возвращает здоровье.
Возвращает:
- number - Требуемое здоровье.
GetMaxHealth()number
Восстанавливает максимальное количество здоровья.
Возвращает:
- number - Запрошенное максимальное здоровье.
IsAlive()boolean
Проверяет, жив ли он.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
GetAbsOrigin()Vector
Возвращает происхождение абс.
Возвращает:
- Vector - Результат звонка.
GetOrigin()Vector
Возвращает происхождение.
Возвращает:
- Vector - Результат звонка.
GetRotation()Angle
Получает вращение.
Возвращает:
- Angle - Результат звонка.
GetAbsRotation()Angle
Получает вращение пресса.
Возвращает:
- Angle - Результат звонка.
GetScale()number
Возвращает масштаб.
Возвращает:
- number - Запрошенный масштаб.
SetScale(scale: number)void
Устанавливает масштаб.
scalenumber - Значение шкалы.
GetDistance(point: Vector)number
Возвращает расстояние.
pointVector - Точка использования.
Возвращает:
- number - Запрошенное расстояние.
GetDistance2D(point: Vector)number
Возвращает расстояние2 d.
pointVector - Точка использования.
Возвращает:
- number - Запрошенное расстояние2 d.
GetDistanceToEntity(ent: Entity)number
Получает расстояние до объекта.
entEntity - Сущность, которую нужно использовать.
Возвращает:
- number - Запрошенное расстояние до объекта.
GetDistance2DToEntity(ent: Entity)number
Получает объект distance2 dto.
entEntity - Сущность, которую нужно использовать.
Возвращает:
- number - Запрошенный объект distance2 dto.
IsOnScreen()boolean
Проверяет, отображается ли оно на экране.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
WorldToScreen(onScreenCheck?: boolean)[number, number, boolean]
Преобразует положение объекта из мирового пространства в пространство экрана.
onScreenCheckboolean (необязательный) - Проверка на экране.
Возвращает:
- [number, number, boolean] - Результат звонка.
GetTeamNum()number
Получает номер команды.
Возвращает:
- number - Запрошенный номер команды.
IsSameTeam(other: Entity)boolean
Проверяет, находится ли сущность в одной команде с другой сущностью.
otherEntity - Другой.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsDormant()boolean
Проверяет, находится ли он в состоянии покоя.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsEntity()boolean
Проверяет, является ли это сущностью.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsNPC()this is NPC
Проверяет, является ли это npc.
Возвращает:
- this is NPC - Результат звонка.
IsHero()this is Hero
Проверяет, герой ли это.
Возвращает:
- this is Hero - Результат звонка.
IsPlayer()this is Player
Проверяет, является ли это игроком.
Возвращает:
- this is Player - Результат звонка.
IsAbility()this is Ability
Проверяет, является ли это способностью.
Возвращает:
- this is Ability - Результат звонка.
IsItem()this is Item
Проверяет, является ли это элементом.
Возвращает:
- this is Item - Результат звонка.
IsPhysicalItem()this is PhysicalItem
Проверяет, является ли это физическим предметом.
Возвращает:
- this is PhysicalItem - Результат звонка.
IsTree()this is Tree
Проверяет, является ли это деревом.
Возвращает:
- this is Tree - Результат звонка.
IsTempTree()this is TempTree
Проверяет, является ли это временным деревом.
Возвращает:
- this is TempTree - Результат звонка.
IsRune()this is Rune
Проверяет, руна ли это.
Возвращает:
- this is Rune - Результат звонка.
IsPositionInRange(position: Vector, range: number, hull?: number)boolean
Проверяет, находится ли позиция в пределах диапазона объекта.
positionVector - Позиция для использования.rangenumber - Значение диапазона.hullnumber (необязательный) - Значение радиуса корпуса.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsEntityInRange(entity: Entity, range: number)boolean
Проверяет, находится ли другой объект в пределах досягаемости.
entityEntity - Сущность, которую нужно использовать.rangenumber - Значение диапазона.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
HasModel()this is ModelEntity
Проверяет, есть ли у него модель.
Возвращает:
- this is ModelEntity - Результат звонка.
GetOwner<T = NPC>()T | null
Возвращает владельца.
Возвращает:
- T | null - Соответствующий объект или
nullесли он недоступен.
GetOwnerRecursive()Entity | null
Рекурсивно извлекает владельца.
Возвращает:
- Entity | null - Соответствующий объект или
nullесли он недоступен.
IsRecursiveOwnedByIndex(index: number)boolean
Проверяет, принадлежит ли сущность рекурсивно указанному индексу.
indexnumber - Значение индекса.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsRecursiveOwnedByHandle(handle: number)boolean
Проверяет, принадлежит ли сущность рекурсивно указанному дескриптору.
handlenumber - Ручка.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsOwnedByIndex(index: number)boolean
Проверяет, принадлежит ли сущность указанному индексу.
indexnumber - Значение индекса.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsOwnedByHandle(handle: number)boolean
Проверяет, принадлежит ли сущность указанному дескриптору.
handlenumber - Ручка.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
IsOwnedBy(entity: Entity)boolean
Проверяет, принадлежит ли сущность указанной сущности.
entityEntity - Сущность, которую нужно использовать.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
GetEntityName()string
Получает имя сущности.
Возвращает:
- string - Запрошенное имя объекта.
GetDesignerName()string
Получает имя дизайнера.
Возвращает:
- string - Запрошенное имя дизайнера.
GetCreationTick()number
Получает галочку создания.
Возвращает:
- number - Запрошенная галочка создания.
IsUpdated()boolean
эквивалент ent.GetCreationTick() != GameRules.GetTickCount()
Возвращает:
- boolean - возвращает true, если объект был создан не в текущем тике
GetModelName()string
Получает имя модели.
Возвращает:
- string - Запрошенное название модели.
IsTeamSuitable(ent: Entity, teamType: Enum.TeamType)boolean
Проверяет, подходит ли команда.
entEntity - Сущность, которую нужно использовать.teamTypeEnum.TeamType - Фильтр выбора команды.
Возвращает:
- boolean - Истина, если условие выполнено, и ложь в противном случае.
GetEntitiesInRadiusByClass<T extends Entity = Entity>(radius: number, teamType: Enum.TeamType, className: string)Array<T>
Извлекает объекты в радиусе по классу.
radiusnumber - Значение радиуса.teamTypeEnum.TeamType - Фильтр выбора команды.classNamestring — Имя класса для проверки или запроса.
Возвращает:
- Array<T> - Массив с совпадающими значениями.
GetEntitiesInRadius(radius: number, teamType: Enum.TeamType)Entity[]
Извлекает объекты в радиусе.
radiusnumber - Значение радиуса.teamTypeEnum.TeamType - Фильтр выбора команды.
Возвращает:
- Entity[] - Массив с совпадающими значениями.
GetHeroesInRadius(radius: number, teamType: Enum.TeamType)Hero[]
Возвращает героев в радиусе.
radiusnumber - Значение радиуса.teamTypeEnum.TeamType - Фильтр выбора команды.
Возвращает:
- Hero[] - Массив с совпадающими значениями.
GetUnitsInRadius(radius: number, teamType: Enum.TeamType)NPC[]
Получает единицы измерения в радиусе.
radiusnumber - Значение радиуса.teamTypeEnum.TeamType - Фильтр выбора команды.
Возвращает:
- NPC[] - Массив с совпадающими значениями.
GetTreesInRadius(radius: number, isActive?: boolean)Tree[]
Извлекает деревья в радиусе.
radiusnumber - Значение радиуса.isActiveboolean (необязательный) - Активен.
Возвращает:
- Tree[] - Массив с совпадающими значениями.
GetTempTreeInRadius(radius: number)TempTree[]
Получает временное дерево в радиусе.
radiusnumber - Значение радиуса.
Возвращает:
- TempTree[] - Массив с совпадающими значениями.
GetTreeOrTempTreeInRadius(radius: number)(Tree | TempTree)[]
Извлекает дерево или временное дерево в радиусе.
radiusnumber - Значение радиуса.
Возвращает:
DrawDebugRadius(radius: number, color: Color, segments?: number)void
Рисует радиус отладки вокруг объекта.
radiusnumber - Значение радиуса.colorColor – Используемое значение color.segmentsnumber (необязательный) - Количество сегментов.