Avatar (Entity)

This entity needs further investigation

##Overview

Represents the player's character in escape mode games.

##Modding

The following modding options are available...

###data/materials.txt

The Avatar entity is defined in materials.txt.

BEGIN Object

• Name Avatar
• Toughness 100.000
• RenderDepth 2
• ViewRange 12
• Sprite Sonny
• Properties Entity

END

##Notes

This entity seems to be only applicable to "Escape Mode".

This unique entity represents the end-user when they are playing the game as a [Prisoner](Prisoner (Entity)) rather than a [Warden](Warden (Entity)). Unlike all other entities, which are essentially NPCs, the Avatar provides a wide range of interactions which are directly controlled by the player.

The avatar is greatly enhanced (in terms of user control and features) in the v1.0 release. Prior to that (in the alpha releases) the avatar was heavily nerfed.

There are three scenarios which cause this entity to appear on the map:

• Sandbox failure conditions - warden gets arrested for corporate crimes
• Escape mode - player starts game as a prisoner and tries to escape
• Spawned by script - scripts can spawn an avatar (currently untested)

While the Avatar defaults to using the Sonny sprite, the user can change to any other sprite via the "Names in the game" screen (big list of prisoners).

###data/scripts/

Avatar entities expose the following [Properties](Object Properties):

• • .Age - need to confirm
• .AnimateRotation
• .AnimateVelocity
• .Attacker
• .AvatarControl - only in escape mode
• • .BodyArmour - possibly only guard staff?
• .Carried
• .CarrierId
• .Carrying
• • .Category - possibly only prisoners?
• .CellId
• .CellIdTimer
• .Damage
• .Dest
• • .Energy - possibly only guard staff?
• .Equipment
• .FollowerId
• • .Gang - possibly only prisoners?
• .Id
• • .JobId - need to check
• • .Misbehaviour - possibly only prisoners?
• .Name
• • .Needs - possibly only prisoners?
• .Or
• • .Patrol - possibly only guard staff?
• .PlayerOrderPos
• .Pos
• • .RestState - possibly only guard staff?
• • .Slot0..7 - unreliable on entities (can crash game)
• • .Station - possibly only guard staff?
• • .StatusEffects - possibly only prisoners?
• .SubType
• .TargetObject
• .Timer
• .Tooltip
• .Type
• .Vel
• .Walls
• • .Weight - not sure?
• • .WorldObject - doesn't seem to do anything

They also expose the usual [Methods](Object Methods)

##See Also

• [Warden (Entity)](Warden (Entity))
• [Prisoner (Entity)](Prisoner (Entity))