-
Notifications
You must be signed in to change notification settings - Fork 7
Pawn
A Pawn is what the game calls every unit on the game board. The mechs the player controls, the Vek they fight, and neutral entities like tanks are all Pawns.
List of functions:
- AddMoveBonus
- AddWeapon
- ClearQueued
- Fall
- FireWeapon
- FlyAway
- GetArmedWeaponId
- GetCustomPositionScore
- GetDangerScore
- GetDeathEffect
- GetHealth
- GetId
- GetMechName
- GetMoveSpeed
- GetPathProf
- GetPersonality
- GetPilotName
- GetSelectedWeapon
- GetSpace
- GetTarget
- GetTeam
- GetTurnCount
- GetType
- GuardPawn
- IsAbility
- IsAcid
- IsActive
- IsAvoidingMines
- IsBusy
- IsDamaged
- IsDead
- IsEnemy
- IsFire
- IsFlying
- IsFrozen
- IsGrappled
- IsGuarding
- IsJumper
- IsMech
- IsPlayer
- IsRanged
- IsSelected
- IsShield
- IsTeleporter
- IsUndoPossible
- IsWeaponArmed
- Kill
- Move
- ResetUses
- Retreat
- SetAcid
- SetActive
- SetCustomAnim
- SetFrozen
- SetInvisible
- SetMech
- SetMissionCritical
- SetMoveSpeed
- SetMutation
- SetNeutral
- SetPowered
- SetPriorityTarget
- SetShield
- SetSpace
- SetTeam
- SpawnAnimation
Signature: void AddMoveBonus(int)
Gives the Pawn bonus movement speed. When called with positive values, also puts the "Kickoff Boosters" status effect on the Pawn. Calling this function with 0 removes the status effect, and bonus movement. Can be called with negative values to temporarily reduce the Pawn's movement speed.
Calling this after the Pawn has already moved does not allow it to move again this turn.
Signature: void ClearQueued()
Clears (cancels) all attacks this Pawn has queued, as if it were affected by smoke.
Signature: void Fall()
For player's mechs has no effect -- only plays a whooshing sound as if the Pawn were falling, but has no other noticeable effect. For enemy pawns, makes them fall down as if they were thrown into a chasm, even if the tile they're standing on is solid ground.
Signature: boolean FireWeapon(Point, int)
Orders the Pawn to fire its weapon in the specified index at the specified location. This ends the Pawn's turn, but can be used to fire the Pawn's weapon even if its turn is over. Returns false if the weapon cannot be fired at the specified point, or the Pawn doesn't have a weapon equipped at the specified index. true if the weapon has been successfully fired.
Index is 1-based: value of 1 corresponds to the first weapon the Pawn has equipped; 2 to the second weapon.
Note: if the weapon in the specified index is a passive, the Pawn's turn is ended and the screen shakes, but no damage is done.
Signature: void FlyAway()
Causes the Pawn to fly away upwards, and die instantly.
Signature: int GetArmedWeaponId()
For player-controlled Pawns and while in targeting mode, returns index of the weapon that the player is currently aiming. Returns -1 otherwise.
Signature: int GetHealth()
Returns a number indicating the amount of remaining health this Pawn has.
Signature: int GetId()
Returns a number the game uses to uniquely identify this particular Pawn.
Signature: string GetMechName()
Returns the Pawn's display name. Works for Vek as well. Examples: for PunchMech returns Punch Mech; for Leaper1 returns Leaper.
Signature: int GetMoveSpeed()
Returns the number of squares the Pawn can move (ie. its move speed).
Signature: boolean GetPathProf(Point, int)
Checks whether this pawn can reach the specified point from its current position, using the specified pathing logic constant:
- PATH_FLYER
- PATH_GROUND
- PATH_MASSIVE
- PATH_PHASING
- PATH_PROJECTILE
- PATH_ROADRUNNER
Signature: string GetPersonality()
Returns the name of the Personality associated with the pilot of the Pawn. Returns Artificial for unpiloted Mechs, Pawns with no pilot and Vek.
Signature: string GetPilotName(int)
Returns the last name of the Pawn's pilot. For Vek, returns their display name.
Signature: int GetSelectedWeapon()
For Pawns with a queued attack, returns index of the weapon whose attack has been queued.
Signature: Point GetSpace()
Returns the position of this Pawn on the game board as a Point.
Signature: Point GetTarget()
Appears to always return a Point with both x and y set to -1.
Signature: int GetTeam()
Returns number representing the team this Pawn belongs to:
- TEAM_ANY
- TEAM_BOTS
- TEAM_ENEMY
- TEAM_ENEMY_MAJOR
- TEAM_MECH
- TEAM_NONE
- TEAM_PLAYER
Signature: int GetTurnCount()
Returns the number of turns the Pawn has been alive for.
Signature: string GetType()
Returns the name of the pawn in Lua files. For example, for the Rift Walker's Prime mech, this function returns PunchMech; for the basic Leaper Vek, this function returns Leaper1, and so on.
Signature: void GuardPawn(boolean)
Doesn't make the Pawn unpushable. Appears to have no effect, regardless of the argument.
Signature: boolean IsAbility(string)
Checks whether this Pawn has the specified pilot skill, and if that skill requires power to function, checks if it is powered. If so, returns true; otherwise returns false.
Signature: boolean IsAcid()
Returns true if this Pawn is affected by ACID. false otherwise.
Signature: boolean IsActive()
Returns true if this Pawn can still move this turn. false if this Pawn has already moved this turn.
Signature: boolean IsDamaged()
Returns true if this Pawn has been damaged and is no longer at full HP. Returns false otherwise. If this Pawn has taken damage and then regained the lost health, this function returns false.
Signature: boolean IsDead()
Returs true if Pawn's health is at 0. false otherwise.
Signature: boolean IsEnemy()
Returns true if the Pawn is hostile to the player. false if it is friendly or neutral.
Signature: boolean IsFire()
Returns true if the Pawn is afflicted by the Fire status. false otherwise.
Signature: boolean IsFlying()
Returns true if this Pawn is flying. false otherwise.
Signature: boolean IsFrozen()
Returns true if this Pawn is frozen. false otherwise.
Signature: boolean IsGrappled()
Returns true if the Pawn is caught in webbing, and unable to move. false otherwise.
Signature: boolean IsGuarding()
Returns true if this Pawn is immune to push effects. false otherwise
Signature: boolean IsJumper()
Returns true if this Pawn moves by leaping to its destination. false otherwise.
Signature: boolean IsMech()
Returns true if this Pawn is a mech, ie. has the Repair skill. false otherwise.
Signature: boolean IsPlayer()
Appears to returns true if this Pawn is not hostile to the player, regardless of whether the player can actually control the pawn or not. false for enemy pawns.
Signature: boolean IsRanged()
Appears to always return false for player mechs. For other pawns, returns true if the pawn has a ranged attack. false otherwise.
Signature: boolean IsSelected()
Returns true if the Pawn is currently selected by the player. false otherwise.
Note: during enemy turn, Pawns taking action are automatically selected.
Signature: boolean IsShield()
Returns true if the Pawn is shielded. false otherwise.
Signature: boolean IsTeleporter()
Returns true if this Pawn moves by teleporting directly to its destination. false otherwise.
Signature: boolean IsWeaponArmed()
Appears to return true if it is currently the Pawn's turn, and it hasn't taken an action yet. Appears to always return false for non-player pawns.
Signature: void Kill(boolean)
Instantly kills this Pawn. Changing the value of the argument had no noticeable effect.
Note: this function failed to kill a Pawn that had 999 HP.
Signature: boolean Move(Point)
Orders the Pawn to move towards the specified point. This function ignores the Pawn's normal move speed, meaning that as long as there is a path to the specified point, the Pawn will reach it. If the point is occupied by another Pawn, building, mountain, or another obstacle, the Pawn will move to the nearest available point. If no path is available (eg. blocked by Vek), then the Pawn will not move. If the Pawn's turn is over, this function does nothing and returns false. Otherwise appears to always return true (even for points outside of the game board).
Signature: void ResetUses()
UNDOCUMENTED
Takes no arguments, returns nothing. ???
Signature: void Retreat()
Appears to just kill the Pawn. Normal death animation is played, Vek do not burrow away.
Signature: void SetAcid(boolean)
Setting this to true makes the Pawn affected by ACID. Setting to false removes it.
Signature: void SetActive(boolean)
Setting this to false marks the Pawn as having already made its move this turn. Can be set back to true to mark the Pawn as if it hasn't made its move this turn yet.
Setting this to true after the Pawn has already made its move this turn will allow it to attack again. If the Pawn has attacked without moving, this allows the Pawn to move again.
Signature: void SetCustomAnim(string)
Sets the animation of the pawn to the animation with the specified name.
This allows to change the appearance of a pawn for the remainder of the mission. The argument can be either an animation namespace (eg. MechPunch) - in which case the pawn will use all animations within that namespace (a, _broken, death, etc.) or a specific animation (eg. MechPunch_broken). Any animation defined in animations.lua is a valid argument.
The appearance persists after the mission is over, displaying the custom animation in island view. However, it is reset back to the mech's normal appearance when a new mission is started.
To revert back to the pawn's default animation, use pawn:SetCustomAnim(_G[pawn:GetType()].Image)
Signature: void SetFrozen(boolean)
Setting this to true freezes the Pawn, encasing it in ice. Setting this to false frees the Pawn from ice. Animations play as expected.
Signature: void SetInvisible(boolean)
Makes this Pawn invisible. Invisible pawns still occupy spaces they stand on, and can be selected by the player. Invisible enemies still execute their attacks, and their attack predictions are still visible to the player.
Signature: void SetMech()
Sets the type of the unit to mech. Gives the pawn the Repair skill.
Signature: void SetMoveSpeed(int)
Sets the move speed of this Pawn to the specified value. Negative values are capped to 0.
Signature: void SetMutation(int)
Appears to be used to apply effects of Psions' auras to the Pawn. Visual and sound effects associated with each status effect are played, and the status effect is applied to the Pawn. If there's no Psion associated with the given effect currently on the board and on the Pawn's team, the effect is immediately removed.
Calling this function when the Pawn is affected by the specified aura has no effect. Calling it with a different argument when the Pawn is already affected by another aura clears the old aura's effect.
| Argument value | Description |
|---|---|
| 0 | Removes existing mutation (no effect if not affected by any mutation) |
| 1 | Extra health |
| 2 | Unknown (missing effect icon) |
| 3 | Unknown (missing effect icon) |
| 4 | Regeneration |
| 5 | Armored |
| 6 | Explosive |
| 7 | Overpowered |
| 8 | Tentacle (damage every turn) |
Signature: void SetNeutral(boolean)
Has no apparent effect for player's mechs and enemy pawns. For non-mech pawns under the player's control, setting this to true allows to revoke the player's control over the Pawn. Setting to false restores player's control over the pawn. Neutral units are controlled by the computer during enemy turn.
Signature: void SetPowered(boolean)
Settings this to false causes the Pawn to become permanently inactive, until set back to true. The Pawn will not become active during its turn, and its animation will be suspended.
Signature: void SetShield(boolean)
Setting this to true puts a shield bubble on the Pawn. Setting to false removes the shield. Animation plays as expected, but there's no sound.
Signature: void SetSpace(Point)
Forcibly moves the Pawn to the specified point, ignoring all game limitations. Can be used to move the Pawn on top of another pawn, a building, or mountain -- even outside the game board.
Signature: void SetTeam(int)
Sets the team of the Pawn. This changes ownership of the Pawn, making it hostile to the player or controllable by them. Team constants:
- TEAM_ANY
- TEAM_BOTS
- TEAM_ENEMY
- TEAM_ENEMY_MAJOR
- TEAM_MECH
- TEAM_NONE
- TEAM_PLAYER
Signature: void SpawnAnimation()
Plays the Pawn's spawning animation. Mechs fall down the sky, Vek burrow out of the ground.