dispctrl

Note: this command is outdated because it assumes the user is running the console/setting.

This command is used to send display commands to a specific user's console.

The command syntax is:

dispctrl -pc PCid -setting settingid -user userId display-cmd

where,

Option

Description

-pc PCid

The PC database id of the character being displayed.

-setting settingid

The Setting database id of the character being displayed.

-user userid

The User database id of the user logged in.

display-cmd

Command	Params	Description
text	text region	Display literal text (as provided as text) in the region with the label region. If the region is not active, the text will not be displayed.
prompt	region query value promptType	Prompt the user with the query at the region specified, providing the default value. The response is expected to be of promptType, such as int, yn, dice roll, etc.
select	region options xid	Present the user with a pull down selection at the region specified. The list of options is a semi-colon separated list. The xid is the transaction id, which has a matching record in the GuiXid database table. The xid is used to direct the response to the correct application.
attn	text	Present some attention text to the user. Attention text is displayed prominently and disappears after a minute.
chat	from text	Insert a chat message into the user's chat dialog box. It is displayed as being from user with the name from.
textarea	region text xid	Present the user with a scrollable text area at the region specified. The text is provided as default text to edit. The xid is the transaction id, which has a matching record in the GuiXid database table. The xid is used to direct the response to the correct application.
clear	region	Whatever is presently displayed in region is erased/cleared.
show	region	If already hidden, whatever is presently displayed in region is revealed.
hide	region	Whatever is presently displayed in region is hidden.
selection	value region	Set the default selection to value for a select control already displayed at region.
record	region recordName values	Display a record in region with the templated text file recordName using the values provided. The values provide are separated by semi-colons or newlines in the format of [key]=value.
setmenu	menu submenu action	Add a new menu item into the user's display. Add the menu item submen under the menu menu. The action provided will be sent to the running app to process. Undefined actions are ignored.
unsetmenu	menu submenu	Remove a menu item from a user's display.
setwindow	name	Create or bring forward the named window.
unsetwindow	name	Clear the named windows.