Class: Update
protocol.Update
Represents an Update.
Implements
Constructors
constructor
• new Update(properties?): Update
Constructs a new Update.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdate | Properties to set |
Returns
Properties
light
• light: number
Update light.
Implementation of
voxel
• voxel: number
Update voxel.
Implementation of
vx
• vx: number
Update vx.
Implementation of
vy
• vy: number
Update vy.
Implementation of
vz
• vz: number
Update vz.
Implementation of
Methods
create
▸ create(properties?): Update
Creates a new Update instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdate | Properties to set |
Returns
Update instance
decode
▸ decode(reader, length?): Update
Decodes an Update message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Update
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Update
Decodes an Update message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Reader | Uint8Array | Reader or buffer to decode from |
Returns
Update
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified Update message. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdate | Update message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Update message, length delimited. Does not implicitly verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdate | Update message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Update
Creates an Update message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Update
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Update
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toJSON
▸ toJSON(): Object
Converts this Update to JSON.
Returns
Object
JSON object
toObject
▸ toObject(message, options?): Object
Creates a plain object from an Update message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Update | Update |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object
verify
▸ verify(message): string
Verifies an Update message.
Parameters
| Name | Type | Description |
|---|---|---|
message | Object | Plain object to verify |
Returns
string
null if valid, otherwise the reason why it is not