Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implements Room.Terrain and room.getTerrain() #103

Merged
merged 3 commits into from
Oct 26, 2018
Merged

Implements Room.Terrain and room.getTerrain() #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd430ec
Implements Room.Terrain and room.getTerrain
pyrodogg Oct 13, 2018
f8f4ae9
disables newline-per-chained-call due to tslint/prettier fight
pyrodogg Oct 13, 2018
308dd8a
Updates getTerrain comment
pyrodogg Oct 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion dist/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1744,6 +1744,11 @@ type STRUCTURE_CONTAINER = "container";
type STRUCTURE_NUKER = "nuker";
type STRUCTURE_PORTAL = "portal";

// Terrain mask constants
type TERRAIN_MASK_WALL = 1;
type TERRAIN_MASK_SWAMP = 2;
type TERRAIN_MASK_LAVA = 4;

// Resource Constants

type ResourceConstant =
Expand Down Expand Up @@ -2809,7 +2814,15 @@ interface RoomTerrain {
* @param y Y position in the room.
* @return number Number of terrain mask like: TERRAIN_MASK_SWAMP | TERRAIN_MASK_WALL
*/
get(x: number, y: number): number;
get(x: number, y: number): 0 | TERRAIN_MASK_WALL | TERRAIN_MASK_SWAMP;
}

interface RoomTerrainConstructor extends _Constructor<RoomTerrain> {
/**
* Get room terrain for the specified room. This method works for any room in the world even if you have no access to it.
* @param roomName String name of the room.
*/
new (roomName: string): RoomTerrain;
}
declare class RoomVisual {
/**
Expand Down Expand Up @@ -3182,6 +3195,11 @@ interface Room {
* @returns A RoomPosition object or null if it cannot be obtained.
*/
getPositionAt(x: number, y: number): RoomPosition | null;
/**
* Get a Room.Terrain object which provides fast access to static terrain data.
* This method works for any room in the world even if you have no access to it.
*/
getTerrain(): RoomTerrain;
/**
* Get the list of objects at the specified room position.
* @param x The X position.
Expand Down Expand Up @@ -3282,6 +3300,9 @@ interface Room {

interface RoomConstructor extends _Constructor<Room> {
new (id: string): Room;

Terrain: RoomTerrainConstructor;

/**
* Serialize a path array into a short string representation, which is suitable to store in memory.
* @param path A path array retrieved from `Room.findPath`.
Expand Down
Loading