# Entity
Базовый класс структуры сущностей.
# GetProperty
Возвращает значение свойства класса.
Аргументы:
className
-string
propertyName
-string
Возвращаемые значения:
string
|number
|boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let propertyValue = myHero.GetProperty("C_BaseEntity", "m_iHealth");
console.log(`Значение здоровья ${propertyValue}`);
};
RegisterScript(exampleScript);
# IsPhysicalItem
Проверяет существует ли Entity предмета в мире.
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (entity.IsPhysicalItem()) {
console.log(
`В мире находится предмет с названием - ${entity.GetClassName()}`
);
}
}
};
RegisterScript(exampleScript);
# IsExist
Проверяет существует ли Entity.
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (entity.IsExist()) {
console.log(`${entity.GetClassName()} - существует`);
}
}
};
RegisterScript(exampleScript);
# GetTrueMaximumDamage
Возвращает значение суммы максимального белого урона и зелёного урона.
Возвращаемые значения:
number
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(
`Значение GetTrueMaximumDamage - ${myHero.GetTrueMaximumDamage()}`
);
};
RegisterScript(exampleScript);
# GetClassName
Возвращает название класса Entity.
Возвращаемые значения:
string
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Название класса моего героя - ${myHero.GetClassName()}`);
};
RegisterScript(exampleScript);
# IsEntity
Проверяет является ли объект Entity.
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Мой герой Entity - ${myHero.IsEntity()}`);
};
RegisterScript(exampleScript);
# IsSameTeam
Проверяет находится ли данный Entity в одной команде с заданным.
Аргументы:
entity
- Entity
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
let className = entity.GetClassName();
console.log(
`Мой герой в одной команде с ${className} - ${myHero.IsSameTeam(entity)}`
);
}
};
RegisterScript(exampleScript);
# IsNPC
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Мой герой является NPC - ${myHero.IsNPC()}`);
};
RegisterScript(exampleScript);
# IsPlayer
Проверяет является ли Entity - Player .
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
console.log(
`${entity.GetClassName()} является Player ${entity.IsPlayer()}`
);
}
};
RegisterScript(exampleScript);
# IsAbility
Проверяет является ли Entity - Ability .
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
console.log(
`${entity.GetClassName()} является Ability ${entity.IsAbility()}`
);
}
};
RegisterScript(exampleScript);
# IsAlive
Проверяет живой ли Entity.
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Мой герой живой - ${myHero.IsAlive()}`);
};
RegisterScript(exampleScript);
# IsDormant
Проверяет находится ли Entity не в области видимости ( тумане войны ).
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
console.log(
`${entity.GetClassName()} не в области видимости ${entity.IsDormant()}`
);
}
};
RegisterScript(exampleScript);
# GetHealth
Возвращает здоровье Entity.
Возвращаемые значения:
number
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Здоровье героя - ${myHero.GetHealth()}`);
};
RegisterScript(exampleScript);
# GetMaxHealth
Возвращает максимальное здоровье Entity.
Возвращаемые значения:
number
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Максимальное здоровье героя - ${myHero.GetMaxHealth()}`);
};
RegisterScript(exampleScript);
# GetTeamNum
Возвращает номер команды Entity.
Возвращаемые значения:
number
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Номер команды героя - ${myHero.GetMaxHealth()}`);
};
RegisterScript(exampleScript);
# GetOrigin
Возвращает позицию Entity.
Почти всегда GetOrigin возвращает значение *GetAbsOrigin и желательно использовать его *.
Возвращаемые значения:
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Позиция героя - ${myHero.GetOrigin()}`);
};
RegisterScript(exampleScript);
# GetAbsOrigin
Возвращает абсолютную позицию Entity.
Возвращаемые значения:
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Абсолютная позиция героя - ${myHero.GetAbsOrigin()}`);
};
RegisterScript(exampleScript);
# GetRotation
Возвращает угол поворта Entity.
Почти всегда GetRotation возвращает значение *GetAbsRotation и желательно использовать его *.
Возвращаемые значения:
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Угол поворота героя - ${myHero.GetRotation()}`);
};
RegisterScript(exampleScript);
# GetAbsRotation
Возвращает абсолютную позицию Entity.
Возвращаемые значения:
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Абсолютный угол поворота героя - ${myHero.GetAbsRotation()}`);
};
RegisterScript(exampleScript);
# GetIndex
Возвращает index Entity.
Возвращаемые значения:
number
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Index героя - ${myHero.GetIndex()}`);
};
RegisterScript(exampleScript);
# GetHandle
Возвращает handle Entity.
Возвращаемые значения:
number
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Handle героя - ${myHero.GetHandle()}`);
};
RegisterScript(exampleScript);
# IsRecursiveOwnedByIndex
Проверяет, что Entity владеет Entity с заданным индексом.
Аргументы:
index
-number
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (myHero.IsRecursiveOwnedByIndex(entity.GetIndex())) {
console.log(`Мой герой владеет ${entity.GetClassName()}`);
}
}
};
RegisterScript(exampleScript);
# IsRecursiveOwnedByIndex
Проверяет, что Entity владеет Entity с заданным index.
Аргументы:
index
-number
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (myHero.IsRecursiveOwnedByIndex(entity.GetIndex())) {
console.log(`Мой герой владеет ${entity.GetClassName()}`);
}
}
};
RegisterScript(exampleScript);
# IsRecursiveOwnedByHandle
Проверяет, что Entity владеет Entity с заданным handle.
Аргументы:
handle
-number
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (myHero.IsRecursiveOwnedByHandle(entity.GetHandle())) {
console.log(`Мой герой владеет ${entity.GetClassName()}`);
}
}
};
RegisterScript(exampleScript);
# IsOwnedByIndex
Проверяет, что Entity с заданным index владеет Entity.
Аргументы:
index
-number
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (myHero.IsOwnedByIndex(entity.GetIndex())) {
console.log(`${entity.GetClassName()} владеет моим героем`);
}
}
};
RegisterScript(exampleScript);
# IsOwnedByHandle
Проверяет, что Entity с заданным handle владеет Entity.
Аргументы:
handle
-number
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (myHero.IsOwnedByHandle(entity.GetHandle())) {
console.log(`${entity.GetClassName()} владеет моим героем`);
}
}
};
RegisterScript(exampleScript);
# IsOwnedBy
Проверяет, что заданный Entity владеет Entity.
Аргументы:
entity
- Entity
Возвращаемые значения:
boolean
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let entities = EntitySystem.GetEntitiesList();
for (let entity of entities) {
if (myHero.IsOwnedBy(entity)) {
console.log(`${entity.GetClassName()} владеет моим героем`);
}
}
};
RegisterScript(exampleScript);
# GetOwner
Возвращает владельца Entity.
Возвращаемые значения:
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Моим героем владеет ${myHero.GetOwner().GetClassName()}`);
};
RegisterScript(exampleScript);
# GetOwnerRecursive
Возвращает того кем владеет Entity .
Возвращаемые значения:
- Entity |
null
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
console.log(`Мой герой владеет ${myHero.GetOwnerRecursive().GetClassName()}`);
};
RegisterScript(exampleScript);
# GetHeroesInRadius
Возвращает список героев вокруг.
Аргументы:
radius
-number
teamType
- Enum.TeamType
Возвращаемые значения:
- Hero[ ]
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let heroesInRadius = myHero.GetHeroesInRadius(500, Enum.TeamType.TEAM_ENEMY);
console.log(`Вокруг моего героя ${heroesInRadius.length} героев врага`);
};
RegisterScript(exampleScript);
# GetUnitsInRadius
Возвращает список юнитов вокруг.
Аргументы:
radius
-number
teamType
- Enum.TeamType
Возвращаемые значения:
- NPC[ ]
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let heroesInRadius = myHero.GetUnitsInRadius(500, Enum.TeamType.TEAM_ENEMY);
console.log(`Вокруг моего героя ${heroesInRadius.length} юнитов врага`);
};
RegisterScript(exampleScript);
radius: number, isActive: boolean
# GetTreesInRadius
Возвращает список деревьев вокруг.
Аргументы:
radius
-number
isActive
-boolean
(Еслиtrue
не добавляет срубленные деревья)
Возвращаемые значения:
- Tree[ ]
Пример использования:
let exampleScript = {};
exampleScript.OnUpdate = () => {
if (!GameRules.IsActiveGame()) {
return;
}
let myHero = EntitySystem.GetLocalHero();
let heroesInRadius = myHero.GetTreesInRadius(500, true);
console.log(`Вокруг моего героя ${heroesInRadius.length} деревьев`);
};
RegisterScript(exampleScript);