org.rsmod.game.pathfinder.flag.CollisionFlag.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rsmod-pathfinder Show documentation
A custom BFS pathfinder implementation to emulate RS.
The newest version!
@file:Suppress("MemberVisibilityCanBePrivate", "unused")

package org.rsmod.game.pathfinder.flag

public object CollisionFlag {

    public const val WALL_NORTH_WEST: Int = 0x1
    public const val WALL_NORTH: Int = 0x2
    public const val WALL_NORTH_EAST: Int = 0x4
    public const val WALL_EAST: Int = 0x8
    public const val WALL_SOUTH_EAST: Int = 0x10
    public const val WALL_SOUTH: Int = 0x20
    public const val WALL_SOUTH_WEST: Int = 0x40
    public const val WALL_WEST: Int = 0x80
    public const val OBJECT: Int = 0x100
    public const val WALL_NORTH_WEST_PROJECTILE_BLOCKER: Int = 0x200
    public const val WALL_NORTH_PROJECTILE_BLOCKER: Int = 0x400
    public const val WALL_NORTH_EAST_PROJECTILE_BLOCKER: Int = 0x800
    public const val WALL_EAST_PROJECTILE_BLOCKER: Int = 0x1000
    public const val WALL_SOUTH_EAST_PROJECTILE_BLOCKER: Int = 0x2000
    public const val WALL_SOUTH_PROJECTILE_BLOCKER: Int = 0x4000
    public const val WALL_SOUTH_WEST_PROJECTILE_BLOCKER: Int = 0x8000
    public const val WALL_WEST_PROJECTILE_BLOCKER: Int = 0x10000
    public const val OBJECT_PROJECTILE_BLOCKER: Int = 0x20000
    public const val FLOOR_DECORATION: Int = 0x40000

    /**
     * Custom flag dedicated to blocking NPCs.
     * It should be noted that this is a custom flag, and you do not need to use this.
     * The pathfinder takes the flag as a custom option, so you may use any other flag, this just defines
     * a reliable constant to use
     */
    public const val BLOCK_NPCS: Int = 0x80000

    /**
     * Custom flag dedicated to blocking players, projectiles as well as NPCs.
     * An example of a monster to set this flag is Brawler. Note that it is unclear if this flag
     * prevents NPCs, as there is a separate flag option for it.
     * This flag is similar to the one above, except it's strictly for NPCs.
     */
    public const val BLOCK_PLAYERS: Int = 0x100000

    public const val FLOOR: Int = 0x200000
    public const val WALL_NORTH_WEST_ROUTE_BLOCKER: Int = 0x400000
    public const val WALL_NORTH_ROUTE_BLOCKER: Int = 0x800000
    public const val WALL_NORTH_EAST_ROUTE_BLOCKER: Int = 0x1000000
    public const val WALL_EAST_ROUTE_BLOCKER: Int = 0x2000000
    public const val WALL_SOUTH_EAST_ROUTE_BLOCKER: Int = 0x4000000
    public const val WALL_SOUTH_ROUTE_BLOCKER: Int = 0x8000000
    public const val WALL_SOUTH_WEST_ROUTE_BLOCKER: Int = 0x10000000
    public const val WALL_WEST_ROUTE_BLOCKER: Int = 0x20000000
    public const val OBJECT_ROUTE_BLOCKER: Int = 0x40000000

    /**
     * Roof flag, used to bind NPCs to not leave the buildings they spawn in. This is a custom flag.
     */
    public const val ROOF: Int = 0x80000000.toInt()

    /* A shorthand combination of both the floor flags. */
    private const val FLOOR_BLOCKED = FLOOR or FLOOR_DECORATION

    /* Mixed masks of the above flags */
    public const val BLOCK_WEST: Int = WALL_EAST or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_EAST: Int = WALL_WEST or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_SOUTH: Int = WALL_NORTH or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_NORTH: Int = WALL_SOUTH or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_SOUTH_WEST: Int = WALL_NORTH or
        WALL_NORTH_EAST or
        WALL_EAST or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_SOUTH_EAST: Int = WALL_NORTH_WEST or
        WALL_NORTH or
        WALL_WEST or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_NORTH_WEST: Int = WALL_EAST or
        WALL_SOUTH_EAST or
        WALL_SOUTH or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_NORTH_EAST: Int = WALL_SOUTH or
        WALL_SOUTH_WEST or
        WALL_WEST or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_NORTH_AND_SOUTH_EAST: Int = WALL_NORTH or
        WALL_NORTH_EAST or
        WALL_EAST or
        WALL_SOUTH_EAST or
        WALL_SOUTH or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_NORTH_AND_SOUTH_WEST: Int = WALL_NORTH_WEST or
        WALL_NORTH or
        WALL_SOUTH or
        WALL_SOUTH_WEST or
        WALL_WEST or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_NORTH_EAST_AND_WEST: Int = WALL_NORTH_WEST or
        WALL_NORTH or
        WALL_NORTH_EAST or
        WALL_EAST or
        WALL_WEST or
        OBJECT or
        FLOOR_BLOCKED

    public const val BLOCK_SOUTH_EAST_AND_WEST: Int = WALL_EAST or
        WALL_SOUTH_EAST or
        WALL_SOUTH or
        WALL_SOUTH_WEST or
        WALL_WEST or
        OBJECT or
        FLOOR_BLOCKED

    /* Route blocker flags. These are used in ~550+ clients to generate paths through bankers and such. */
    public const val BLOCK_WEST_ROUTE_BLOCKER: Int = WALL_EAST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_EAST_ROUTE_BLOCKER: Int = WALL_WEST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_SOUTH_ROUTE_BLOCKER: Int = WALL_NORTH_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_NORTH_ROUTE_BLOCKER: Int = WALL_SOUTH_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_SOUTH_WEST_ROUTE_BLOCKER: Int = WALL_NORTH_ROUTE_BLOCKER or
        WALL_NORTH_EAST_ROUTE_BLOCKER or
        WALL_EAST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_SOUTH_EAST_ROUTE_BLOCKER: Int = WALL_NORTH_WEST_ROUTE_BLOCKER or
        WALL_NORTH_ROUTE_BLOCKER or
        WALL_WEST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_NORTH_WEST_ROUTE_BLOCKER: Int = WALL_EAST_ROUTE_BLOCKER or
        WALL_SOUTH_EAST_ROUTE_BLOCKER or
        WALL_SOUTH_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_NORTH_EAST_ROUTE_BLOCKER: Int = WALL_SOUTH_ROUTE_BLOCKER or
        WALL_SOUTH_WEST_ROUTE_BLOCKER or
        WALL_WEST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_NORTH_AND_SOUTH_EAST_ROUTE_BLOCKER: Int = WALL_NORTH_ROUTE_BLOCKER or
        WALL_NORTH_EAST_ROUTE_BLOCKER or
        WALL_EAST_ROUTE_BLOCKER or
        WALL_SOUTH_EAST_ROUTE_BLOCKER or
        WALL_SOUTH_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_NORTH_AND_SOUTH_WEST_ROUTE_BLOCKER: Int = WALL_NORTH_WEST_ROUTE_BLOCKER or
        WALL_NORTH_ROUTE_BLOCKER or
        WALL_SOUTH_ROUTE_BLOCKER or
        WALL_SOUTH_WEST_ROUTE_BLOCKER or
        WALL_WEST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_NORTH_EAST_AND_WEST_ROUTE_BLOCKER: Int = WALL_NORTH_WEST_ROUTE_BLOCKER or
        WALL_NORTH_ROUTE_BLOCKER or
        WALL_NORTH_EAST_ROUTE_BLOCKER or
        WALL_EAST_ROUTE_BLOCKER or
        WALL_WEST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
    public const val BLOCK_SOUTH_EAST_AND_WEST_ROUTE_BLOCKER: Int = WALL_EAST_ROUTE_BLOCKER or
        WALL_SOUTH_EAST_ROUTE_BLOCKER or
        WALL_SOUTH_ROUTE_BLOCKER or
        WALL_SOUTH_WEST_ROUTE_BLOCKER or
        WALL_WEST_ROUTE_BLOCKER or
        OBJECT_ROUTE_BLOCKER or
        FLOOR_BLOCKED
}