Difference between revisions of "User:Gwyrdain"
(Created page with "[https://drive.google.com/folderview?id=0Bx0DtUKkkHGiVERYR0xRSTJsblE&usp=sharing TFC Specific Cmud Files]") |
|||
Line 1: | Line 1: | ||
=Cmud Files= | |||
The below is a link to a google drive folder hosting Cmud scripts (as xml exports). At the moment only simple scripts are provided as a test case with the intent of adding more complicated scripts (e.g., MSDP implementation) if all goes well. | |||
[https://drive.google.com/folderview?id=0Bx0DtUKkkHGiVERYR0xRSTJsblE&usp=sharing TFC Specific Cmud Files] | [https://drive.google.com/folderview?id=0Bx0DtUKkkHGiVERYR0xRSTJsblE&usp=sharing TFC Specific Cmud Files] | ||
To install: (a) open the Package manager in Cmud (Ctrl-G / "View->All Settings" on the pull down menu / Settings button on the Main Toolbar), (b) select a location at which to perform the import (if you don't know what this means select the root of your main window), and (c) use "File->Import XML" on the pull down menu to perform the import. | |||
==Message_Functions== | |||
This set of scripts provides generic messaging functions used in other scripts. Only the "Debug" toggle command is intended for command line use. | |||
{|class="wikitable" cellpadding=5 style="border:1px | |||
! width=150 |Name!! width=150 |Type!! | Description | |||
|- | |||
|Debug||Alias||<B>Syntax:</B> <I>Debug</I><BR>Creates and/or toggles a variable "DebugMode" in the "Settings" class between ON (1) or OFF (0). | |||
|- | |||
|DebugMessage||Alias||<B>Syntax:</B> <I>DebugMessage <message></I><BR>Displays a debug message in the main window only if DebugMode is ON. | |||
|- | |||
|ErrorMessage||Alias||<B>Syntax:</B> <I>ErrorMessage <message></I><BR>Displays an error message in the main window. | |||
|- | |||
|InfoMessage||Alias||<B>Syntax:</B> <I>InfoMessage <message></I><BR>Displays an informational message in the main window. | |||
|- | |||
|RepeatChar||Function||<B>Syntax:</B> <I>@RepeatChar($char,$num)</I><BR>Returns a string consisting of a given character or string, repeated a given number of times. (Useful in building and padding tables using fixed width fonts.) | |||
|} | |||
==TFCQ-Seeker== | |||
(Requires <B>Message_Functions</B>) | |||
This set of scripts allows the user to indicate a text string or pattern that they are looking for which will be highlighted when seen. | |||
Example: You are looking for a mouse in an area with numerous mobiles. Rather than stop in every room and read/scan the mobile long descriptions, just set a 'seek mouse' and the word mouse will be highlighted whenever seen. Use 'seek' with no parameters to turn off seeing. | |||
{|class="wikitable" cellpadding=5 style="border:1px | |||
! width=150 |Name!! width=150 |Type!! | Description | |||
|- | |||
|seek||Alias||<B>Syntax:</B> <I>seek <pattern></I><BR>Sets the pattern to be sought and turns on the pattern seeking trigger. When no pattern is given the seek pattern is set to a blank string and the seek trigger is turned off. | |||
|- | |||
|SeekPattern||Variable||Sting variable storing the pattern currently being sought. Empty string when not seeking. | |||
|- | |||
|SPMatcher||Trigger||Trigger for finding and highlighting the pattern being sought. This trigger is turned off when not seeking | |||
|} | |||
==Potion_Identification== | |||
This set of scripts displays the spells or possible spells for random potions. Settings are configurable, though they must be set manually. | |||
{|class="wikitable" cellpadding=5 style="border:1px | |||
! width=150 |Name!! width=150 |Type!! | Description | |||
|- | |||
|IgnoreIdentifiedPotions||Variable||Integer variable. Set to 1 (ON) to disable operation of potion identification for any potion short description that already includes improved identify markings. | |||
|- | |||
|PotionTextColor||Variable||String variable. Set to the html color name used for the potion identification text foreground color. | |||
|- | |||
|PotionTextFont||Variable||String variable. Set to the name of the font used for the potion identification text. | |||
|- | |||
|PotionTextSize||Variable||String variable. Set to the size of the font used for the potion identification text (e.g., 1-7) | |||
|- | |||
|PotionTypes||Variable||Database record variable. Table of potion colors as keys and the associated spell(s) as value (including any special formatting). | |||
|- | |||
|a (*) potion...||Trigger||Trigger for finding potions and displaying the potion identification, as applicable. (Typical of three triggers.) | |||
|- | |||
|FormatPotionTypes||Function||<B>Syntax:</B> <I>@FormatPotionTypes($potioncolors)</I><BR>Returns a fully formatted string describing a potion with the given colors where colors are passed as a string list varibale. Used by the potion triggers. | |||
|- | |||
|} |
Revision as of 13:44, 19 June 2014
Cmud Files
The below is a link to a google drive folder hosting Cmud scripts (as xml exports). At the moment only simple scripts are provided as a test case with the intent of adding more complicated scripts (e.g., MSDP implementation) if all goes well.
To install: (a) open the Package manager in Cmud (Ctrl-G / "View->All Settings" on the pull down menu / Settings button on the Main Toolbar), (b) select a location at which to perform the import (if you don't know what this means select the root of your main window), and (c) use "File->Import XML" on the pull down menu to perform the import.
Message_Functions
This set of scripts provides generic messaging functions used in other scripts. Only the "Debug" toggle command is intended for command line use.
Name | Type | Description |
---|---|---|
Debug | Alias | Syntax: Debug Creates and/or toggles a variable "DebugMode" in the "Settings" class between ON (1) or OFF (0). |
DebugMessage | Alias | Syntax: DebugMessage <message> Displays a debug message in the main window only if DebugMode is ON. |
ErrorMessage | Alias | Syntax: ErrorMessage <message> Displays an error message in the main window. |
InfoMessage | Alias | Syntax: InfoMessage <message> Displays an informational message in the main window. |
RepeatChar | Function | Syntax: @RepeatChar($char,$num) Returns a string consisting of a given character or string, repeated a given number of times. (Useful in building and padding tables using fixed width fonts.) |
TFCQ-Seeker
(Requires Message_Functions)
This set of scripts allows the user to indicate a text string or pattern that they are looking for which will be highlighted when seen.
Example: You are looking for a mouse in an area with numerous mobiles. Rather than stop in every room and read/scan the mobile long descriptions, just set a 'seek mouse' and the word mouse will be highlighted whenever seen. Use 'seek' with no parameters to turn off seeing.
Name | Type | Description |
---|---|---|
seek | Alias | Syntax: seek <pattern> Sets the pattern to be sought and turns on the pattern seeking trigger. When no pattern is given the seek pattern is set to a blank string and the seek trigger is turned off. |
SeekPattern | Variable | Sting variable storing the pattern currently being sought. Empty string when not seeking. |
SPMatcher | Trigger | Trigger for finding and highlighting the pattern being sought. This trigger is turned off when not seeking |
Potion_Identification
This set of scripts displays the spells or possible spells for random potions. Settings are configurable, though they must be set manually.
Name | Type | Description |
---|---|---|
IgnoreIdentifiedPotions | Variable | Integer variable. Set to 1 (ON) to disable operation of potion identification for any potion short description that already includes improved identify markings. |
PotionTextColor | Variable | String variable. Set to the html color name used for the potion identification text foreground color. |
PotionTextFont | Variable | String variable. Set to the name of the font used for the potion identification text. |
PotionTextSize | Variable | String variable. Set to the size of the font used for the potion identification text (e.g., 1-7) |
PotionTypes | Variable | Database record variable. Table of potion colors as keys and the associated spell(s) as value (including any special formatting). |
a (*) potion... | Trigger | Trigger for finding potions and displaying the potion identification, as applicable. (Typical of three triggers.) |
FormatPotionTypes | Function | Syntax: @FormatPotionTypes($potioncolors) Returns a fully formatted string describing a potion with the given colors where colors are passed as a string list varibale. Used by the potion triggers. |