forked from Garethp/ScreepsAutocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathConstructionSite.js
84 lines (75 loc) · 1.88 KB
/
ConstructionSite.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/**
* A site of a structure which is currently under construction.
* A construction site can be created using the 'Construct' button at the left of the game field or the Room.createConstructionSite() method.
* Construction sites are visible to their owners only.
* To build a structure on the construction site, give a worker creep some amount of energy and perform Creep.build() action.
*
* @class
* @constructor
*/
ConstructionSite = function() { };
ConstructionSite.prototype = {
/**
* A unique object identifier. You can use Game.getObjectById method to retrieve an object instance by its id.
*
* @type {number}
*/
id: 0,
/**
* Whether this is your own construction site.
*
* @type {boolean}
*/
my: true,
/**
* An object with the structure’s owner info.
*
* @type {object}
*/
owner: {
/**
* The name of the owner user.
*
* @type {string}
*/
username: ""
},
/**
* An object representing the position of this structure in the room.
*
* @type {RoomPosition}
*/
pos: null,
/**
* The current construction progress.
*
* @type {number}
*/
progress: 0,
/**
* The total construction progress needed for the structure to be built.
*
* @type {number}
*/
progressTotal: 0,
/**
* The link to the Room object of this structure.
*
* @type {Room}
*/
room: null,
/**
* One of the STRUCTURE_* constants.
*
* @type {string}
*/
structureType: "",
/**
* Remove the construction site.
*
* @return {number|OK|ERR_NOT_OWNER} Returns one of the following codes:
* OK if the operation has been scheduled or
* ERR_NOT_FOUND if you are not the owner of this construction site
*/
remove: function() { }
};