Lua Ascent Script Documentation

[latruwski]

Taken straight from the Ascent wiki:

Lua Command Documentation

Generic Lua Commands

Print "some console info..."

Unit Events

RegisterUnitEvent(UnitID, Event, "Function Name")

Units Commands

:GetName() : Returns the unit's name.
:GetX() : Returns the unit's X position.
:GetY() : Returns the unit's Y position.
:GetZ() : Returns the unit's Z position.
:GetO() : Returns the unit's orientation.
:IsPlayer() : Returns true if the unit is a player, false otherwise.
:IsCreature() : Returns true if the unit is a creature, false otherwise.
:HasFinishedQuest(questID) : Returns true or false depending on if the quest has been completed.
:GetItemCount(itemID) : Returns the number of the items a unit has.
:GetHealthPct() : Returns the unit's health as a percentage.
:GetUnitBySqlId(sqlID) : Returns a unit from the sql ID.
:GetClosestPlayer() : Returns the nearest in-range unit that is a player.
:GetRandomPlayer(flags) : Returns a random in-range unit that is a player.
:GetRandomFriend() : Returns a random in-range unit that is a player and is friendly towards the current player.
:GetMainTank() : Returns the main tank (most hated).
:GetAddTank() : Returns the add tank (second most hated).
:GetTauntedBy() : Returns the player that taunted the unit.

:RegisterEvent() :
:SendChatMessage(type, language, message) : 'Unit says: <message>' style chat message.
:SendBroadcastMessage(message) :
:SendAreaTriggerMessage(message) :
:MoveTo(x, y, z, o) : Moves the unit to the specified position.
:CastSpell(spellID) : Causes the unit to cast a spell.
:CastSpellOnTarget(spellID, unitTarget) : Casts a spell on a target unit.
:FullCastSpell(spellID) : Casts a spell with casting time.
:FullCastSpellOnTarget(spellID, unitTarget) : Casts a spell with casting time on a target unit.
:SpawnGameObject(entryID, x, y, z, o, duration) : Spawns a gameobject at the specified position, despawning after duration milliseconds.
:SpawnCreature(entryID, x, y, z, o, faction, duration) : Spawns a creature at a position with specified faction, despawning after duration milliseconds.
:KnockBack(dx, dy, affect1, affect2) :
:MarkQuestObjectiveAsComplete(questID, objective) : Marks an objective of a quest as complete.
:LearnSpell(spellID) : Adds a spell to a unit.
:UnlearnSpell(spellID) : Removes a spell from a unit.
espawn(delay, respawn) : Despawns a unit after delay milliseconds and respawns it after respawn milliseconds.
:PlaySoundToSet(soundID) : Plays a sound to the surrounding area.
:RemoveAura(auraID) : Removes an aura from a unit.
:StopMovement(time) : Stops a unit from moving for time milliseconds.
:Emote(emoteID) : Tells a unit to perform an emote.
:AddItem(itemID, count) : Adds a quantity of items to a unit.
:RemoveItem(itemID, count) : Removes a quantity of items from a unit.
:CreateCustomWaypointMap() : Creates a custom waypoint map.
:CreateWaypoint(x, y, z, o, waitTime, flags, modelID) : Adds a waypoint to the custom waypoint map.
estroyCustomWaypointMap() : Destroys a created custom waypoint map.
:MoveToWaypoint(waypointID) : Tells a unit to move to a particular waypoint.
:SetMovementType(movementType) :
:SetCombatCapable(value) : If value is 0 the unit cannot attack.
:SetNPCFlags(flags) : Sets the NPC flags of a unit.
:SetModel(modelID) : Sets the model (display ID) of a unit.
:SetScale(scale) : Sets the scale (size) of a unit.
:SetFaction(factionID) : Sets the faction of a unit.
:SetTauntedBy(unit) : Sets the unit that taunted the current unit.

GameObject Events

RegisterGameObjectEvent(GameObjectID, Event, "Function Name")

GameObject Commands

:GetName() : Returns the gameobject's name.

:SpawnCreature(entryID, x, y, z, o, faction, duration) : Spawns a creature at a position with specified faction, despawning after duration milliseconds.
:PlayCustomAnim() :
:PlaySoundToSet() :


note: credit goes to Ascent Wiki !


grtz