Class Error

Hierarchy (view full)

ButtplugMessage
- Error

Index

Constructors

Properties

ErrorCode ErrorMessage Id Name

Accessors

Schemversion Type

Methods

toJSON toProtocolFormat update

Constructors

constructor

new Error(ErrorMessage, ErrorCode?, Id?): Error
Parameters
- ErrorMessage: string
- ErrorCode: ErrorClass = ErrorClass.ERROR_UNKNOWN
- Id: number = DEFAULT_MESSAGE_ID
Returns Error
Overrides ButtplugMessage.constructor
- Defined in src/core/Messages.ts:150

Properties

ErrorCode

ErrorCode: ErrorClass = ErrorClass.ERROR_UNKNOWN

ErrorMessage

ErrorMessage: string

Id

Id: number = DEFAULT_MESSAGE_ID

`Static` Name

Name: string = 'Error'

Accessors

Schemversion

get Schemversion(): number
Returns number
- Defined in src/core/Messages.ts:158

Type

get Type(): Function
Returns Function
Inherited from ButtplugMessage.Type
- Defined in src/core/Messages.ts:93

Methods

toJSON

toJSON(): string
Returns string
Inherited from ButtplugMessage.toJSON
- Defined in src/core/Messages.ts:97

toProtocolFormat

toProtocolFormat(): object
Returns object
Inherited from ButtplugMessage.toProtocolFormat
- Defined in src/core/Messages.ts:101

update

update(): void
Returns void
Inherited from ButtplugMessage.update
- Defined in src/core/Messages.ts:108

Generated using TypeDoc