dreamworkAPI
Ctrl K
GitHub
libraryDocs / input / clipboard

input.clipboard

libraryclientmenusource

The clipboard module allows to manipulate the client's clipboard.

Functions

input.clipboard.addTextAdds text to the clipboard.
input.clipboard.clearClears the clipboard.
input.clipboard.getTextReturns the contents of the clipboard.
input.clipboard.setTextSets the contents of the clipboard.

#input.clipboard.addText

clientmenusource
function input.clipboard.addText(text: string)

Adds text to the clipboard.

Parameters
NameTypeDescription
textstring

#input.clipboard.clear

clientmenusource
function input.clipboard.clear()

Clears the clipboard.

#input.clipboard.getText

clientmenunodiscardsource
function input.clipboard.getText(): string

Returns the contents of the clipboard.

Returns
TypeNameDescription
string

#input.clipboard.setText

clientmenusource
function input.clipboard.setText(text: string)

Sets the contents of the clipboard.

Parameters
NameTypeDescription
textstring
Generated from the dreamwork meta branch.