quick_fov()

Complexity

Conditions

6

Size

Total Lines

72

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

"""
def quick_fov(x, y, callback, fov='PERMISSIVE', radius=7.5, lightWalls=True,

The name x does not conform to the argument naming conventions ([a-z_][a-z0-9_]{2,30}$).

The name y does not conform to the argument naming conventions ([a-z_][a-z0-9_]{2,30}$).

The name lightWalls does not conform to the argument naming conventions ([a-z_][a-z0-9_]{2,30}$).

              sphere=True):
    """All field-of-view functionality in one call.

    Before using this call be sure to make a function, lambda, or method that takes 2

This line is too long as per the coding-style (85/80).

    positional parameters and returns True if light can pass through the tile or False

This line is too long as per the coding-style (86/80).

    for light-blocking tiles and for indexes that are out of bounds of the
    dungeon.

    This function is 'quick' as in no hassle but can quickly become a very slow
    function call if a large radius is used or the callback provided itself
    isn't optimized.

    Always check if the index is in bounds both in the callback and in the
    returned values.  These values can go into the negatives as well.

    Args:
        x (int): x center of the field-of-view
        y (int): y center of the field-of-view
        callback (Callable[[int, int], bool]):

            This should be a function that takes two positional arguments x,y
            and returns True if the tile at that position is transparent
            or False if the tile blocks light or is out of bounds.
        fov (Text): The type of field-of-view to be used.

            Available types are:
            'BASIC', 'DIAMOND', 'SHADOW', 'RESTRICTIVE', 'PERMISSIVE',
            'PERMISSIVE0', 'PERMISSIVE1', ..., 'PERMISSIVE8'
        radius (float) Radius of the field-of-view.

            When sphere is True a floating point can be used to fine-tune
            the range.  Otherwise the radius is just rounded up.

            Be careful as a large radius has an exponential affect on
            how long this function takes.
        lightWalls (bool): Include or exclude wall tiles in the field-of-view.
        sphere (bool): True for a spherical field-of-view.
            False for a square one.

    Returns:
        Set[Tuple[int, int]]: A set of (x, y) points that are within the
            field-of-view.
    """
    trueRadius = radius

The name trueRadius does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

    radius = int(_math.ceil(radius))
    mapSize = radius * 2 + 1

The name mapSize does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

    fov = _get_fov_type(fov)

    setProp = _lib.TCOD_map_set_properties # make local

The name setProp does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

    inFOV = _lib.TCOD_map_is_in_fov

The name inFOV does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

    tcodMap = _lib.TCOD_map_new(mapSize, mapSize)

The name tcodMap does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

    try:
        # pass no.1, write callback data to the tcodMap
        for x_, y_ in _itertools.product(range(mapSize), range(mapSize)):

The name x_ does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

The name y_ does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            pos = (x_ + x - radius,
                   y_ + y - radius)
            transparent = bool(callback(*pos))
            setProp(tcodMap, x_, y_, transparent, False)

        # pass no.2, compute fov and build a list of points
        _lib.TCOD_map_compute_fov(tcodMap, radius, radius, radius, lightWalls, fov)

This line is too long as per the coding-style (83/80).

        touched = set() # points touched by field of view
        for x_, y_ in _itertools.product(range(mapSize), range(mapSize)):

The name x_ does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

The name y_ does not conform to the variable naming conventions ([a-z_][a-z0-9_]{2,30}$).

            if sphere and _math.hypot(x_ - radius, y_ - radius) > trueRadius:
                continue
            if inFOV(tcodMap, x_, y_):
                touched.add((x_ + x - radius, y_ + y - radius))
    finally:
        _lib.TCOD_map_delete(tcodMap)
    return touched