Other great resources: Official JS API docs, Scripting Forum

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Requires tutorial mode

In order for this function to work, you need to be in tutorial mode. Activate tutorial mode with the setTutorialMode() function. 

Overview

This function allows you to enable a reticule button.

Syntax

addReticuleButton(button);

Parameters

ParameterTypeMandatoryDescription
buttonConstant(tick)

A constant defining which button to display:

  • BUILDUsed to show or hide the "Build" (hammer) reticule button.
  • CANCELUsed to show or hide the "Cancel" (central) reticule button.
  • COMMANDUsed to show or hide the "Command" (star) reticule button.
  • DESIGNUsed to show or hide the "Design" (blue components) reticule button.
  • INTELMAPUsed to show or hide the "Intelligence" (earth map) reticule button.
  • MANUFACTUREUsed to show or hide the "Maufacture" (factory) reticule button.
  • OPTIONSThis constant is deprecated, use COMMAND instead.
  • RESEARCHUsed to show or hide the "Research" (green circuit board) reticule button.

Return value

ValueTypeDescription
undefinedUndefinedThe reticule button was added (or was already present)
<error>ErrorThe "button" parameter contained an invalid constant.

Example

Enable the research button
setTutorialMode(true);
addReticuleButton(RESEARCH);

See also

  • No labels