Module pacai.core.agentstate

Classes

class AgentState (position, direction, isPacman)

Expand source code

class AgentState:
    """
    This class hold the state of an agent (position, direction, scared, etc).

    The convention for positions, like a graph, is that (0, 0) is the lower left corner,
    x increases horizontally and y increases vertically.
    Therefore, north is the direction of increasing y, or (0, 1).
    """

    def __init__(self, position, direction, isPacman):
        # Save the starting information for later use.
        self._startPosition = position
        self._startDirection = direction
        self._startIsPacman = isPacman

        self._position = position
        self._direction = direction

        self._isPacman = isPacman
        self._scaredTimer = 0

    def copy(self):
        state = AgentState(self._startPosition, self._startDirection, self._startIsPacman)

        state._isPacman = self._isPacman
        state._position = self._position
        state._direction = self._direction
        state._scaredTimer = self._scaredTimer

        return state

    def decrementScaredTimer(self):
        self._scaredTimer = max(0, self._scaredTimer - 1)

    def getDirection(self):
        return self._direction

    def getPosition(self):
        return self._position

    def getNearestPosition(self):
        return util.nearestPoint(self._position)

    def getScaredTimer(self):
        return self._scaredTimer

    def isBraveGhost(self):
        """
        A ghost that is not scared.
        """

        return (self.isGhost() and not self.isScared())

    def isGhost(self):
        return not self.isPacman()

    def isPacman(self):
        return self._isPacman

    def isScared(self):
        return (self._scaredTimer > 0)

    def isScaredGhost(self):
        return (self.isGhost() and self.isScared())

    def setIsPacman(self, isPacman):
        self._isPacman = isPacman

    def setScaredTimer(self, timer):
        self._scaredTimer = timer

    def snapToNearestPoint(self):
        """
        Move the agent to the nearest point to its current location.
        """

        self._position = util.nearestPoint(self._position)

    def respawn(self):
        """
        This agent was killed, respawn it at the start as a pacman.
        """

        self._position = self._startPosition
        self._direction = self._startDirection
        self._isPacman = self._startIsPacman
        self._scaredTimer = 0

    def updatePosition(self, vector):
        """
        Update the position and direction with the given movement vector.
        """

        x, y = self._position
        dx, dy = vector

        self._position = (x + dx, y + dy)

        direction = Actions.vectorToDirection(vector)
        if (direction != Directions.STOP):
            # If this is a zero vector, face the same direction as before.
            self._direction = direction

    def __eq__(self, other):
        if (other is None):
            return False

        return (self._position == other._position
                and self._direction == other._direction
                and self._isPacman == other._isPacman
                and self._scaredTimer == other._scaredTimer)

    def __hash__(self):
        return util.buildHash(self._position, self._direction, self._isPacman, self._scaredTimer)

    def __str__(self):
        typeString = 'Ghost'
        if (self.isPacman()):
            typeString = 'Pacman'

        scaredString = ''
        if (self.isScared()):
            scaredString = '!'

        return "%s%s: Position: %s, Direction: %s" % (typeString, scaredString,
                str(self._position), str(self._direction))

This class hold the state of an agent (position, direction, scared, etc).

The convention for positions, like a graph, is that (0, 0) is the lower left corner, x increases horizontally and y increases vertically. Therefore, north is the direction of increasing y, or (0, 1).

Methods

def copy(self)

Expand source code

def copy(self):
    state = AgentState(self._startPosition, self._startDirection, self._startIsPacman)

    state._isPacman = self._isPacman
    state._position = self._position
    state._direction = self._direction
    state._scaredTimer = self._scaredTimer

    return state

def decrementScaredTimer(self)

Expand source code

def decrementScaredTimer(self):
    self._scaredTimer = max(0, self._scaredTimer - 1)

def getDirection(self)

Expand source code

def getDirection(self):
    return self._direction

def getNearestPosition(self)

Expand source code

def getNearestPosition(self):
    return util.nearestPoint(self._position)

def getPosition(self)

Expand source code

def getPosition(self):
    return self._position

def getScaredTimer(self)

Expand source code

def getScaredTimer(self):
    return self._scaredTimer

def isBraveGhost(self)

Expand source code

def isBraveGhost(self):
    """
    A ghost that is not scared.
    """

    return (self.isGhost() and not self.isScared())

A ghost that is not scared.

def isGhost(self)

Expand source code

def isGhost(self):
    return not self.isPacman()

def isPacman(self)

Expand source code

def isPacman(self):
    return self._isPacman

def isScared(self)

Expand source code

def isScared(self):
    return (self._scaredTimer > 0)

def isScaredGhost(self)

Expand source code

def isScaredGhost(self):
    return (self.isGhost() and self.isScared())

def respawn(self)

Expand source code

def respawn(self):
    """
    This agent was killed, respawn it at the start as a pacman.
    """

    self._position = self._startPosition
    self._direction = self._startDirection
    self._isPacman = self._startIsPacman
    self._scaredTimer = 0

This agent was killed, respawn it at the start as a pacman.

def setIsPacman(self, isPacman)

Expand source code

def setIsPacman(self, isPacman):
    self._isPacman = isPacman

def setScaredTimer(self, timer)

Expand source code

def setScaredTimer(self, timer):
    self._scaredTimer = timer

def snapToNearestPoint(self)

Expand source code

def snapToNearestPoint(self):
    """
    Move the agent to the nearest point to its current location.
    """

    self._position = util.nearestPoint(self._position)

Move the agent to the nearest point to its current location.

def updatePosition(self, vector)

Expand source code

def updatePosition(self, vector):
    """
    Update the position and direction with the given movement vector.
    """

    x, y = self._position
    dx, dy = vector

    self._position = (x + dx, y + dy)

    direction = Actions.vectorToDirection(vector)
    if (direction != Directions.STOP):
        # If this is a zero vector, face the same direction as before.
        self._direction = direction

Update the position and direction with the given movement vector.