cp.spec.Message

Provides an Message message, which can be thrown via the error function.


API Overview

Functions - API calls offered directly by the extension

  • is

Constructors - API calls which return an object, typically one that offers API methods

  • Message

Methods - API calls which can only be made on an object returned by a constructor

  • traceback

API Documentation

Functions

is

   
Signature cp.spec.Message.is(other) -> boolean
Type Function
Description Checks if the other is an instance of the Message class.
Parameters
  • other - The object to compare
Returns
  • A boolean
Notes None
Examples None
Source src/extensions/cp/spec/Message.lua line 9

Constructors

Message

   
Signature cp.spec.Message(message)
Type Constructor
Description Creates a new Message message.
Parameters
  • message - the message to send.
Returns
  • A new message.
Notes None
Examples None
Source src/extensions/cp/spec/Message.lua line 22

Methods

traceback

   
Signature cp.spec.Message:traceback()
Type Method
Description Stores the debug.traceback result at the present time. Can be retrieved via stacktrace
Parameters
  • None
Returns
  • None
Notes None
Examples None
Source src/extensions/cp/spec/Message.lua line 36