Preparing search index...
The search index is not available
Wayward Types Viewer | 2.14.0-beta.dev.20240903.1
Wayward Types Viewer
mod/ModRegistry
default
overlay
Function overlay
overlay
(
name
:
string
, description
?:
IOverlayDescription
)
:
(
<
K
,
T
>
(
target
:
T
, key
:
K
)
=>
void
)
Registers an overlay.
Parameters
name:
string
Optional
description:
IOverlayDescription
The definition of the overlay.
Returns
(
<
K
,
T
>
(
target
:
T
, key
:
K
)
=>
void
)
<
K
,
T
>
(
target
:
T
, key
:
K
)
:
void
Type Parameters
K
extends
string
|
number
|
symbol
T
extends
Record
<
K
,
OverlayType
>
Parameters
target:
T
key:
K
Returns
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Navigation
Modding Guide
Module Index
Common Modules
@Register
IDoodadDescription
IItemDescription
ITerrainDescription
ITileEventDescription
ICreatureDescription
In This Module
action
bindable
biome
bulk
command
creature
dialog
dictionary
doodad
doodad
Group
doodad
Tag
entity
Tag
equip
Type
generic
Enum
help
Article
inspection
Type
inter
Mod
Registration
inter
Mod
Registry
interrupt
Choice
item
item
Group
item
Tag
language
language
Extension
load
magical
Property
menu
Bar
Button
message
message
Source
music
Track
note
npc
options
Section
overlay
override
packet
prompt
quadrant
Component
quest
quest
Requirement
registry
skill
sound
Effect
stat
status
terrain
terrain
Decoration
tile
Event
tile
Group
tile
Layer
usable
Action
Type
usable
Action
Type
Placeholder
usable
Actions
world
Layer
Generated using
TypeDoc
Registers an overlay.