Preparing search index...
The search index is not available
@gathertown/gather-game-client
@gathertown/gather-game-client
SocialRoomSize
Enumeration SocialRoomSize
Index
Enumeration Members
Large
Medium
Small
Enumeration Members
Large
Large
:
"Large (50 - 100 people)"
Medium
Medium
:
"Medium (25 - 50 people)"
Small
Small
:
"Small (1 - 25 people)"
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
On This Page
Large
Medium
Small
@gathertown/gather-
game-
client
Interaction
Move
Direction
Sprite
Direction
Area
Category
Board
Game
Board
Games
Server
Events
Crafting
Ability
Reward
Name
Crafting
Reward
Object
Name
Emote
Enabled
Chat
Event
Error
Codes
Fish
Name
Game
Ws
Close
Code
Grand
Prix
Client
Events
Grand
Prix
Game
Phase
Grand
Prix
Maps
Grand
Prix
Server
Events
Interaction
Enum_
ENUM
Junk
Name
Move
Direction
Enum_
ENUM
Plant
Difficulty
Plant
Health
Plant
Name
Plant
Reward
Name
Plant
Stage
Player
Status
End
Option
Player
Status
Option
Preset
Tutorial
Group
Set
Ids
QUESTION_
PACKS
Respond
To
Access
Request_
Location
Type
Enum
Seed
Name
Social
Room
Social
Room
Size
Sound
Effect
Sprite
Direction
Enum_
ENUM
Tile
Type
Trivia
Game
Phase
Vehicle
Action
Engine
Game
Player
PlayerDBFields
Sliding
Window
Wall
FloorDB
Access
Request
Access
Request
Responded
To
Access
Requests
Updated
Actively
Speaking
Add
Inventory
Item
Allowed
Users
Announcer
Area
Area
Position
Areas
Asset
Backed
Up
Desk
Object
Ban
Base
Area
Block
Board
Games
Game
Updated
Data
Bounding
Box
Chat
Chat
Message
Updated
Chat
Reply
Chime
Sets
User
Info
Client
Backup
Heartbeat
Client
Heartbeat
Client
Server
Action
Client
Server
Batch
Cookie
Found
Craft
Craft_
Inputs
Entry
Custom
Action
Custom
Event
DBArea
DBAreas
DBDesk
DBDesks
DBOutfit
Deprecated
Desk
Info
V2
Desk
Objects
Desk
Objects_
Objects
Entry
Desks
Dynamic
Gate
Dynamic
Gates
Enter
Enter
Portal
Enter
Whisper
Error
Event
Exit
FXShake
Camera
FXShake
Object
Game
Map
Game
Map
Base
Do
Not
Use
Directly
Game
MapDB
Game
Map
Http
Public
Ghost
Got
Request
Mute
Grand
Prix
Finished
Lap
Data
Grand
Prix
Full
State
Data
Grand
Prix
Game
Phase
Data
High
Five
Hip
To
Be
Square
Info
Init
Interact
With
Object
Interaction
Enum
Inventory
Inventory
Item
Inventory_
Items
Entry
Inventory_
Order
Entry
Item
Ability
Join
Chime
Meeting
Kick
Leave
Whisper
Map
Add
Object
Map
And
Desk
Map
Commits
Changes
Map
Delete
Object
By
Id
Map
Delete
Object
By
Key
Map
Location
Map
Move
Object
Map
Name
And
Id
Map
Object
Map
ObjectDB
Map
Set
Announcer
Map
Set
Areas
Map
Set
Areas_
Areas
Entry
Map
Set
Assets
Map
Set
Background
Image
Path
Map
Set
Collisions
Map
Set
Collisions
Bits
Map
Set
Decoration
Map
Set
Description
Map
Set
Dimensions
Map
Set
Enabled
Chats
Map
Set
Floors
Map
Set
Floors_
Floors
Entry
Map
Set
Foreground
Image
Path
Map
Set
Mini
Map
Image
Path
Map
Set
Mute
On
Entry
Map
Set
Name
Map
Set
Nooks
Map
Set
Nooks_
Nooks
Entry
Map
Set
Objects
V2
Map
Set
Objects
V2_
Objects
Entry
Map
Set
Portals
Map
Set
Script
Map
Set
Spawn
Map
Set
Spawns
Map
Set
Tutorial
Tasks
Map
Set
Use
DrawnBG
Map
Set
Walls
Map
Set
Walls_
Walls
Entry
Map
Update
Objects
Map
Update
Objects_
Objects
Entry
Move
Move
Direction
Enum
Nook
Coords
Nook
Diff
Nook
Info
Nook
Tile
Notify
Object
Time
Occupied
Nook
Tiles
Map
Plant
Plant
Info
Play
Sound
Player
Actively
Speaks
Player
Blocks
Player
Chats
Player
Crafts
Player
Crafts_
Inputs
Entry
PlayerDB
Player
Edits
Chat
Message
Player
Enters
Portal
Player
Enters
Whisper
Player
Enters
Whisper
V2
Player
Exits
Player
Ghosts
Player
Guest
Pass
Status
Player
High
Fives
Player
Init
Info
Player
Interacts
With
Object
Player
Joins
Player
Leaves
Whisper
Player
Moves
Player
Notifies
Player
Requests
To
Lead
Player
Rings
Player
Sends
Command
Player
Sets
Affiliation
Player
Sets
Allow
Screen
Pointer
Player
Sets
Availability
Player
Sets
Away
Player
Sets
City
Player
Sets
Country
Player
Sets
Current
Area
Player
Sets
Currently
Equipped
Wearables
Player
Sets
Description
Player
Sets
Desk
Info
Player
Sets
Display
Email
Player
Sets
Emoji
Status
Player
Sets
Emote
V2
Player
Sets
Event
Status
Player
Sets
Focus
Mode
End
Time
Player
Sets
Follow
Target
Player
Sets
Go
Kart
Id
Player
Sets
Image
Pointer
Player
Sets
In
Conversation
Player
Sets
Is
Alone
Player
Sets
Is
Mobile
Player
Sets
Is
Npc
Player
Sets
Is
Signed
In
Player
Sets
Item
String
Player
Sets
Last
Active
Player
Sets
Last
Raised
Hand
Player
Sets
Manual
Video
Src
Player
Sets
Name
Player
Sets
Personal
Image
Url
Player
Sets
Phone
Player
Sets
Profile
Image
Url
Player
Sets
Pronouns
Player
Sets
Speed
Modifier
Player
Sets
Start
Date
Player
Sets
Status
Player
Sets
Subtitle
Player
Sets
Text
Status
Player
Sets
Timezone
Player
Sets
Title
Player
Sets
Vehicle
Id
Player
Shoots
Confetti
Player
Spotlights
Player
Starts
Recording
Player
Triggers
Inventory
Item
Player
Triggers
Object
Player
Updates
Focus
Mode
Status
Player
Updates
Inventory
Player
Updates
Inventory_
Items
Entry
Player
Updates
Inventory_
Order
Entry
Player
Waves
Portal
Portal
Tile
Precompute
Enter
Precomputed
Enter
Location
Ready
Recording
Info
Register
Command
Remove
Inventory
Item
Request
Access
Via
Check
In
Request
Mute
Request
To
Join
Nook
Request
To
Lead
Request
User
Requested
Users
Requested
Users_
Users
Entry
Respawn
Respawn
At
Desk
Respond
To
Access
Request
Ring
Send
Command
Server
Client
Batch
Server
Client
Event
Server
Heartbeat
Set
Affiliation
Set
Allow
Screen
Pointer
Set
Availability
Set
Away
Set
City
Set
Country
Set
Current
Area
Set
Currently
Equipped
Wearables
Set
Description
Set
Desk
From
Next
Available
Desk
Set
Desk
Info
Set
Display
Email
Set
Emoji
Status
Set
Emote
V2
Set
Event
Status
Set
Focus
Mode
End
Time
Set
Follow
Target
Set
Image
Pointer
Set
Impassable
Set
In
Conversation
Set
Is
Alone
Set
Is
Mobile
Set
Item
String
Set
Manual
Video
Src
Set
Name
Set
Personal
Image
Url
Set
Phone
Set
Profile
Image
Url
Set
Pronouns
Set
Screen
Pointer
Set
Screen
Pointer
Server
Set
Space
Role
Permission
Override
Set
Speed
Modifier
Set
Start
Date
Set
Status
Set
Subtitle
Set
Text
Status
Set
Timezone
Set
Title
Set
Vehicle
Id
Shoot
Confetti
Sliding
Window
Metrics
Sound
Space
Space
Is
Closed
Space
Item
Space
Item_
Abilities
Entry
Space
Item_
Meta
Entry
Space
Member
Info
Space
Member
Info_
Roles
Entry
Space
Over
Capacity
Denies
User
Space
Overwrites
Space
Plays
Sound
Space
Registers
Command
Space
Role
Permission
Override
Updated
Space
Sets
Capacity
Space
Sets
Guest
Pass
Statuses
Space
Sets
Id
Mapping
Space
Sets
Space
Members
Space
Sets
Space
Members_
Members
Entry
Space
Sets
Space
Users
Space
Sets
Space
Users_
Space
Users
Entry
Space
Stops
Sound
Space
Updates
Items
Space
Updates
Items_
Items
Entry
Spawn
Spawn
Point
Spawn
Tile
Speaker
Updates
Session
Spotlight
Sprite
Direction
Enum
Start
Recording
Stop
Sound
Subscriptions
Updated
Teleport
Template
Portal
Tile
Timestamp
Transaction
Status
Trigger
Inventory
Item
Trigger
Object
Tutorial
Task
Map
Area
Tutorial
Tasks
Update
Nook
Permission
Update
Subscriptions
Update
Subscriptions_
Map
Update
Ids
Entry
Update
Subscriptions_
Subscriptions
Entry
Warn
Wave
Wire
Area
Wire
Object
Wire
Object
Sprite
Anim
Config
Wire
Object
Spritesheet
Wire
Object
Spritesheet
Framing
Wire
Object
Spritesheet_
Animations
Entry
Wire
Point
Wire
Space
User
Wire
Tutorial
Tasks
Action
Data
By
Case
Base
Room
UserDB
Board
Game
Info
Data
Client
Server
Action
Action
Client
Server
Action
Case
Coords
Map
Current
Submissions
Desk
InfoDB
Engine
Auth
Fishing
Item
Floor
Block
Game
Event
Subscription
Map
Game
Options
Game
State
Garden
Town
Plant
Seed
Grand
Prix
All
Players
Finished
Data
Grand
Prix
End
Race
Data
Grand
Prix
Join
Space
Data
Grand
Prix
Leave
Data
Grand
Prix
Player
Grand
Prix
Player
Finished
Race
Data
Grand
Prix
Player
Ready
Data
Grand
Prix
Select
Track
Data
Grid
Position
Log
Types
Map
Object
To
Add
Map
Position
Modal
Interaction
Nook
Partial
Game
State
PlayerDBPartial
Point
Question
Info
Question
Pack
Question
Packs
Question
Row
Questions
Room
Of
Requirements
Set
Room
Scores
Server
Client
Event
Case
Server
Client
Event
Data
By
Case
Server
Client
Event
Event
Server
Client
Event
Event
With
Submission
Submission
History
Submission
History
Entry
Team
Info
Teams
Tile
Effect
Trivia
Game
State
Trivia
Get
Submission
History
Trivia
Host
Ends
Game
Trivia
Host
Joins
Game
Trivia
Host
Sets
Phase
Trivia
Host
Starts
Game
Trivia
Player
Joins
Game
Trivia
Player
Joins
Team
Trivia
Player
Leaves
Team
Trivia
Server
Time
Trivia
Team
Sets
Name
Trivia
Team
Submits
Answer
Wall
Block
Wall
Floor
Block
World
Position
API_
BASE_
PATH
AUDIENCE_
COORDS
Access
Request
Access
Request
Responded
To
Access
Requests
Updated
Actively
Speaking
Activity
Time
Filter
Options
Add
Inventory
Item
Allowed
Users
Announcer
Area
Position
Asset
BACKGROUND_
MUSIC_
VOLUME
BOARD_
GAME_
MAPS
Backed
Up
Desk
Object
Ban
Block
Board
Game
Info
CONSTANT_
PERMANENT_
EMOTES
CROWN_
IMG
Chat
Chat
Message
Updated
Chat
Reply
Chime
Sets
User
Info
Client
Backup
Heartbeat
Client
Heartbeat
Client
Server
Action
Client
Server
Batch
Cookie
Found
Craft
Craft_
Inputs
Entry
Crafting
Reward
Name
Custom
Action
Custom
Event
DBDesk
DBOutfit
DEFAULT_
NAME
DEFAULT_
PLANT_
STAGES
DEFAULT_
QUESTION_
VALUE
DEFAULT_
TEMP_
EMOTES
DOOR_
AREA_
COORDS
Deprecated
Desk
Info
V2
Desk
Objects
Desk
Objects_
Objects
Entry
Dynamic
Gate
Dynamic
Gates
EMOTE_
EMOJIS
EMOTE_
RESET_
SHORTCUT
EMOTE_
SHORTCUTS
Enter
Enter
Portal
Enter
Whisper
Error
Event
Exit
FINISHED_
PLACE_
COLOR
FXShake
Camera
FXShake
Object
GAME_
STATE_
PLAYER_
DISCONNECT_
SYMBOL
GARDENTOWN_
PLANTER_
PREFIX
GARDENTOWN_
REWARD_
TO_
PLANT
GARDENTOWN_
SEED_
TO_
PLANT
GENERIC_
GAME_
BOX_
OBJ
GRAND_
PRIX_
CHECKPOINT
GRAND_
PRIX_
MAPS
GRAND_
PRIX_
MAP_
SFX
GRAND_
PRIX_
NUM_
LANES
GRAND_
PRIX_
PORTAL
GRAND_
PRIX_
START_
POS
GRAND_
PRIX_
TEMPLATE_
PORTALS
Ghost
Got
Request
Mute
Grand
Prix
Maps
Info
HIP_
TO_
BE_
SQUARE_
MAP
High
Five
Hip
To
Be
Square
Info
Init
Interact
With
Object
Interaction
Enum
Inventory
Inventory
Item
Inventory_
Items
Entry
Inventory_
Order
Entry
Item
Ability
Join
Chime
Meeting
Kick
Leave
Whisper
MAP_
MAX_
DIMENSION
MIN_
NUM_
PLAYERS_
HARVEST
Map
Add
Object
Map
And
Desk
Map
Commits
Changes
Map
Delete
Object
By
Id
Map
Delete
Object
By
Key
Map
Location
Map
Move
Object
Map
Set
Announcer
Map
Set
Areas
Map
Set
Areas_
Areas
Entry
Map
Set
Assets
Map
Set
Background
Image
Path
Map
Set
Collisions
Map
Set
Collisions
Bits
Map
Set
Decoration
Map
Set
Description
Map
Set
Dimensions
Map
Set
Enabled
Chats
Map
Set
Floors
Map
Set
Floors_
Floors
Entry
Map
Set
Foreground
Image
Path
Map
Set
Mini
Map
Image
Path
Map
Set
Mute
On
Entry
Map
Set
Name
Map
Set
Nooks
Map
Set
Nooks_
Nooks
Entry
Map
Set
Objects
V2
Map
Set
Objects
V2_
Objects
Entry
Map
Set
Portals
Map
Set
Script
Map
Set
Spawn
Map
Set
Spawns
Map
Set
Tutorial
Tasks
Map
Set
Use
DrawnBG
Map
Set
Walls
Map
Set
Walls_
Walls
Entry
Map
Update
Objects
Map
Update
Objects_
Objects
Entry
Move
Move
Direction
Enum
NUM_
LAPS
Nook
Coords
Nook
Diff
Notify
Object
Time
PLANT_
INFO_
MAP
PODIUM_
COORDS
Participant
Filter
Options
Play
Sound
Player
Actively
Speaks
Player
Blocks
Player
Chats
Player
Crafts
Player
Crafts_
Inputs
Entry
Player
Edits
Chat
Message
Player
Enters
Portal
Player
Enters
Whisper
Player
Enters
Whisper
V2
Player
Exits
Player
Ghosts
Player
Guest
Pass
Status
Player
High
Fives
Player
Init
Info
Player
Interacts
With
Object
Player
Joins
Player
Leaves
Whisper
Player
Moves
Player
Notifies
Player
Requests
To
Lead
Player
Rings
Player
Sends
Command
Player
Sets
Affiliation
Player
Sets
Allow
Screen
Pointer
Player
Sets
Availability
Player
Sets
Away
Player
Sets
City
Player
Sets
Country
Player
Sets
Current
Area
Player
Sets
Currently
Equipped
Wearables
Player
Sets
Description
Player
Sets
Desk
Info
Player
Sets
Display
Email
Player
Sets
Emoji
Status
Player
Sets
Emote
V2
Player
Sets
Event
Status
Player
Sets
Focus
Mode
End
Time
Player
Sets
Follow
Target
Player
Sets
Go
Kart
Id
Player
Sets
Image
Pointer
Player
Sets
In
Conversation
Player
Sets
Is
Alone
Player
Sets
Is
Mobile
Player
Sets
Is
Npc
Player
Sets
Is
Signed
In
Player
Sets
Item
String
Player
Sets
Last
Active
Player
Sets
Last
Raised
Hand
Player
Sets
Manual
Video
Src
Player
Sets
Name
Player
Sets
Personal
Image
Url
Player
Sets
Phone
Player
Sets
Profile
Image
Url
Player
Sets
Pronouns
Player
Sets
Speed
Modifier
Player
Sets
Start
Date
Player
Sets
Status
Player
Sets
Subtitle
Player
Sets
Text
Status
Player
Sets
Timezone
Player
Sets
Title
Player
Sets
Vehicle
Id
Player
Shoots
Confetti
Player
Spotlights
Player
Starts
Recording
Player
Triggers
Inventory
Item
Player
Triggers
Object
Player
Updates
Focus
Mode
Status
Player
Updates
Inventory
Player
Updates
Inventory_
Items
Entry
Player
Updates
Inventory_
Order
Entry
Player
Waves
Portal
Precompute
Enter
Precomputed
Enter
Location
QUESTION_
PACKS_
INFO
ROOM_
CONTROLLER_
OBJECT_
ID
ROOM_
DOOR_
OBJECT_
ID
ROOM_
OF_
REQUIREMENTS_
EXTENSION
Ready
Recording
Info
Register
Command
Remove
Inventory
Item
Request
Access
Via
Check
In
Request
Mute
Request
To
Join
Nook
Request
To
Lead
Request
User
Requested
Users
Requested
Users_
Users
Entry
Respawn
Respawn
At
Desk
Respond
To
Access
Request
Reward
Name
Ring
SOUND_
EFFECT_
VOLUME
Send
Command
Server
Client
Batch
Server
Client
Event
Server
Heartbeat
Set
Affiliation
Set
Allow
Screen
Pointer
Set
Availability
Set
Away
Set
City
Set
Country
Set
Current
Area
Set
Currently
Equipped
Wearables
Set
Description
Set
Desk
From
Next
Available
Desk
Set
Desk
Info
Set
Display
Email
Set
Emoji
Status
Set
Emote
V2
Set
Event
Status
Set
Focus
Mode
End
Time
Set
Follow
Target
Set
Image
Pointer
Set
Impassable
Set
In
Conversation
Set
Is
Alone
Set
Is
Mobile
Set
Item
String
Set
Manual
Video
Src
Set
Name
Set
Personal
Image
Url
Set
Phone
Set
Profile
Image
Url
Set
Pronouns
Set
Screen
Pointer
Set
Screen
Pointer
Server
Set
Space
Role
Permission
Override
Set
Speed
Modifier
Set
Start
Date
Set
Status
Set
Subtitle
Set
Text
Status
Set
Timezone
Set
Title
Set
Vehicle
Id
Shoot
Confetti
Social
Room
Info
Sound
Space
Space
Is
Closed
Space
Item
Space
Item_
Abilities
Entry
Space
Item_
Meta
Entry
Space
Member
Info
Space
Member
Info_
Roles
Entry
Space
Over
Capacity
Denies
User
Space
Overwrites
Space
Plays
Sound
Space
Registers
Command
Space
Role
Permission
Override
Updated
Space
Sets
Capacity
Space
Sets
Guest
Pass
Statuses
Space
Sets
Id
Mapping
Space
Sets
Space
Members
Space
Sets
Space
Members_
Members
Entry
Space
Sets
Space
Users
Space
Sets
Space
Users_
Space
Users
Entry
Space
Stops
Sound
Space
Updates
Items
Space
Updates
Items_
Items
Entry
Spawn
Spawn
Point
Speaker
Updates
Session
Spotlight
Sprite
Direction
Enum
Start
Recording
Stop
Sound
Subscriptions
Updated
TRIVIA_
COLORS
TRIVIA_
MAP_
ID
Teleport
Timestamp
Transaction
Status
Trigger
Inventory
Item
Trigger
Object
Tutorial
Task
Map
Area
Update
Nook
Permission
Update
Subscriptions
Update
Subscriptions_
Map
Update
Ids
Entry
Update
Subscriptions_
Subscriptions
Entry
Warn
Wave
Wave
Emotes
Wire
Area
Wire
Object
Wire
Object
Sprite
Anim
Config
Wire
Object
Spritesheet
Wire
Object
Spritesheet
Framing
Wire
Object
Spritesheet_
Animations
Entry
Wire
Point
Wire
Space
User
Wire
Tutorial
Tasks
is
Browser
logger
protobuf
Package
protobuf
Writer
Library
shown
Board
Games
abortable
any
Signal
calc
Centroid
convert
Area
Coords
To
Coords
Map
convert
Desks
ToDBDesks
convert
Map
Object
To
Wire
Object
convert
Nook
Info
To
Occupied
Nook
Tiles
Map
convert
String
To
Enabled
Chat
convert
String
To
Preset
Tutorial
Group
Set
Id
convert
Tutorial
Tasks
To
Wire
Tutorial
Tasks
convert
Wire
Areas
To
Areas
convert
Wire
Areas
ToDBAreas
convert
Wire
Object
To
Map
ObjectDBPartial
convert
Wire
Object
To
Map
Object
Partial
convert
Wire
Tutorial
Tasks
To
Tutorial
Tasks
coordinates
To
Index
coords
Map
To
Positions
dangerously
Cast
To
Point
deprecated
Spaces
To
Nooks
deserialize
Point
desks
To
Nooks
direction
To
Face
Player
euclidean
Distance
fetch
Game
Server
Assignment
find
Missing
Map
Object
Fields
generate
Default
Player
generate
New
Id
get
All
Crafting
Reward
Items
get
All
Emotes
get
All
Fish
Items
get
All
Junk
Items
get
All
Plant
Reward
Items
get
All
Seed
Items
get
Bounding
Box
get
Crafted
Reward
Image
get
Crafting
Reward
Item
get
Fish
Item
get
Fishing
Item
Name
To
Image
get
Harvest
Image
get
Is
Gardening
Time
get
Junk
Item
get
Move
Dir
From
Sprite
Dir
get
Next
Gardening
Time
get
Plant
Data
get
Plant
Image
get
Plant
Name
From
Template
Id
get
Plant
Reward
Item
get
Players
Allowed
Harvest
get
Point
From
Bounding
Box
get
Seed
Image
get
Seed
Item
get
Seed
Unplaced
Obj
get
Unused
Object
Key
get
Updated
Grand
Prix
Leaderboards
Data
happened
Today
index
To
Point
interaction
Opens
Modal
is
Assigned
Desk
Info
is
Board
Game
is
Garden
Town
Plant
is
Garden
Town
Planter
is
Map
Object
is
Map
ObjectDB
is
Map
Position
Equal
is
Nook
is
Point
Equal
is
Point
Within
Rectangle
is
RoRActive
is
Ror
Object
is
Ror
Standalone
Object
is
Tile
Type
manhattan
Distance
merge
Nooks
next
Sprite
Direction
nook
To
Deprecated
Spaces
objects
Array
To
Dict
opposite
Move
Direction
parse
Custom
Action
parse
Obj
Custom
State
point
To
Index
position
After
Move
random
Int
From
Interval
serialize
Point
serialize
Point
Coordinates
subtract
Points
target
Maps
test
Connection
whisper
Id
To
Color
Generated using
TypeDoc