Search
Preparing search index...
The search index is not available
Overmind
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
DirectiveClearRoom
Class DirectiveClearRoom
Claims a new room, destroys all structures in the room, then unclaims it
Hierarchy
Directive
DirectiveClearRoom
Index
Constructors
constructor
Properties
colony
memory
name
overlords
pos
ref
requiredRCL
room
color
directive
Name
requiredRCL
secondary
Color
Accessors
flag
print
Methods
alert
init
refresh
remove
remove
All
Structures
run
set
Color
set
Position
spawn
Moar
Overlords
visuals
create
create
IfNot
Present
filter
find
is
Present
Constructors
constructor
new
Directive
Clear
Room
(
flag
:
Flag
)
:
DirectiveClearRoom
Parameters
flag:
Flag
Returns
DirectiveClearRoom
Properties
colony
colony
:
Colony
memory
memory
:
FlagMemory
name
name
:
string
overlords
overlords
:
object
Type declaration
pos
pos
:
RoomPosition
ref
ref
:
string
requiredRCL
requiredRCL
:
number
room
room
:
Room
|
undefined
Static
color
color
:
2
= COLOR_PURPLE
Static
directive
Name
directive
Name
:
string
= "clearRoom"
Static
requiredRCL
requiredRCL
:
number
= 3
Static
secondary
Color
secondary
Color
:
7
= COLOR_ORANGE
Accessors
flag
get
flag
(
)
:
Flag
Returns
Flag
print
get
print
(
)
:
string
Returns
string
Methods
alert
alert
(
message
:
string
, priority
?:
NotifierPriority
)
:
void
Parameters
message:
string
Default value
priority:
NotifierPriority
= NotifierPriority.Normal
Returns
void
init
init
(
)
:
void
Returns
void
refresh
refresh
(
)
:
void
Returns
void
remove
remove
(
force
?:
boolean
)
:
number
|
undefined
Parameters
Default value
force:
boolean
= false
Returns
number
|
undefined
Private
remove
All
Structures
remove
All
Structures
(
)
:
boolean
Returns
boolean
run
run
(
)
:
void
Returns
void
set
Color
set
Color
(
color
:
ColorConstant
, secondaryColor
?:
ColorConstant
)
:
number
Parameters
color:
ColorConstant
Optional
secondaryColor:
ColorConstant
Returns
number
set
Position
set
Position
(
pos
:
RoomPosition
)
:
number
Parameters
pos:
RoomPosition
Returns
number
spawn
Moar
Overlords
spawn
Moar
Overlords
(
)
:
void
Returns
void
visuals
visuals
(
)
:
void
Returns
void
Static
create
create
(
pos
:
RoomPosition
, opts
?:
DirectiveCreationOptions
)
:
number
|
string
Parameters
pos:
RoomPosition
Default value
opts:
DirectiveCreationOptions
= {}
Returns
number
|
string
Static
create
IfNot
Present
create
IfNot
Present
(
pos
:
RoomPosition
, scope
:
"room"
|
"pos"
, opts
?:
DirectiveCreationOptions
)
:
number
|
string
|
undefined
Parameters
pos:
RoomPosition
scope:
"room"
|
"pos"
Default value
opts:
DirectiveCreationOptions
= {}
Returns
number
|
string
|
undefined
Static
filter
filter
(
flag
:
Flag
)
:
boolean
Parameters
flag:
Flag
Returns
boolean
Static
find
find
(
flags
:
Flag
[]
)
:
Directive
[]
Parameters
flags:
Flag
[]
Returns
Directive
[]
Static
is
Present
is
Present
(
pos
:
RoomPosition
, scope
:
"room"
|
"pos"
)
:
boolean
Parameters
pos:
RoomPosition
scope:
"room"
|
"pos"
Returns
boolean
Globals
Directive
Clear
Room
constructor
colony
memory
name
overlords
pos
ref
requiredRCL
room
color
directive
Name
requiredRCL
secondary
Color
flag
print
alert
init
refresh
remove
remove
All
Structures
run
set
Color
set
Position
spawn
Moar
Overlords
visuals
create
create
IfNot
Present
filter
find
is
Present
Generated using
TypeDoc
Claims a new room, destroys all structures in the room, then unclaims it