aom.scripting.ui.console

Class Help

Object

Help

public class Help
extends Object

This class provides a collection of Console commands concerning Help.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Local Call

Help commands are all local.

Method Summary

Modifier and Type	Method and Description
void	databaseHelp(string type, string name) Does simple queries on possible things in the DB.
void	help(string commandSubstring) Deprecated.
void	helpPrefix(string commandPrefix) Deprecated.
void	helpText(string helptextSubstring) Prints a list of all console commands whose helptext contains the given substring.
void	uiHelpAtPointer() Opens a help topic related to the object at the pointer position.
void	uiLastDetailHelp() Goes back to the most recent help entry.
void	uiTechDetailHelp(int techID, int civID) Brings up the detail help UI for the given technology node ID.
void	uiTopicDetailHelp(string topicName) Brings up the detail help UI for the given help topic.
void	uiUnitDetailHelp(int protoID, int civID) Brings up the detail help UI for the given protoID.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

uiHelpAtPointer

public void uiHelpAtPointer()

Opens a help topic related to the object at the pointer position.

uiUnitDetailHelp

public void uiUnitDetailHelp(int protoID,
                             int civID)

Brings up the detail help UI for the given protoID. If no protoID is provided (-1), help for the selected unit is shown.

uiTechDetailHelp

public void uiTechDetailHelp(int techID,
                             int civID)

Brings up the detail help UI for the given technology node ID.

uiTopicDetailHelp

public void uiTopicDetailHelp(string topicName)

Brings up the detail help UI for the given help topic.

uiLastDetailHelp

public void uiLastDetailHelp()

Goes back to the most recent help entry.

help

public void help(string commandSubstring)

Deprecated.

Prints a list of all console commands that contain the given substring.

helpPrefix

public void helpPrefix(string commandPrefix)

Deprecated.

Prints a list of all console commands that start with the given prefix.

helpText

public void helpText(string helptextSubstring)

Prints a list of all console commands whose helptext contains the given substring.

databaseHelp

public void databaseHelp(string type,
                         string name)

Does simple queries on possible things in the DB.