VeggieTales Scripting Reference - Revision history

Jimbly at 05:06, 12 February 2015

2015-02-12T05:06:38Z

Show changes

Cegaiel: /* Screen Reading */

2012-05-23T04:12:18Z

Screen Reading

Tallow at 04:00, 19 May 2012

2012-05-19T04:00:47Z

Tallow: /* Function List */

2012-05-19T03:59:45Z

Function List

Show changes

Skyfeather: /* Text Parsing */

2012-05-09T14:03:26Z

Text Parsing

Skyfeather at 13:57, 9 May 2012

2012-05-09T13:57:23Z

Skyfeather: /* Misc Notes */

2012-05-08T08:39:44Z

Misc Notes

Skyfeather at 07:38, 8 May 2012

2012-05-08T07:38:51Z

Cegaiel at 03:24, 5 May 2012

2012-05-05T03:24:23Z

Cegaiel at 03:17, 23 April 2012

2012-04-23T03:17:05Z

@@ Line 90: / Line 90: @@
 ;void srMakeImage(const char *name, int x, int y, int w, int h)
-:Create a new image file at the given path based on the pixels found on part of the atitd screen.
+:Create a new image 'file', referenced later by the 'name' at the given path based on the pixels found on part of the atitd screen. srMakeImage does not make a file on disk, it makes an "image" to be used for srFindImage, or displayed with srShowImageDebug (see multi_click.lua). The image "name" can be referenced in the above functions.
 ;Vec2 srFindImage(const char *fn, int tol)

@@ Line 26: / Line 26: @@
 * Note that you *MUST* call srReadScreen to update the screen before calling srFindImageInRange etc.
 == Function List ==
@@ Line 307: / Line 314: @@
 ;Vec2 getMousePos()
 :Returns the current location of the mouse.

@@ Line 78: / Line 78: @@
    parse[] getAllText()
    parse findTextInParse(parse[] p, String t, bool isExact)
 I recommend not using the below functions unless you're modifying lua library functions.
    void srStripScreen()
@@ Line 84: / Line 85: @@
    region srFindNextTextRegion()
    parse[] srParseTextRegion(int x0, int y0, int w, int h)
    region srFindChatRegion()
    void srTrainTextReader(int x, int y, const char *c)
 === User Interface ===
    int lsScreenX

@@ Line 64: / Line 64: @@
    Parse object is a table where parse[0] = x0, parse[1] = y0, parse[2] = text
    region[] findAllTextRegions()
-   parse findText(String s)
+   parse findText(String s, bool isExact)
    void stripRegion(region r)
    parse[] parseRegion(region r)
-   parse findTextInRegion(region r, String t)
+   parse findTextInRegion(region r, String t, bool isExact)
-   region[] findAllRegionsWithText(String t)
+   region[] findAllRegionsWithText(String t, bool isExact)
-   parse waitForText(String t)
+   parse waitForText(String t, int delay, int timeout, bool isExact)
-   void waitForNoText(String t)
+   int waitForNoText(String t, int delay, int timeout, bool isExact)
-   region waitForRegionWithText(String t)
+   region waitForRegionWithText(String t, int delay, int timeout, bool isExact)
-   parse waitForTextInRegion(Region r, String t)
+   parse waitForTextInRegion(Region r, String t, int delay, int timeout, bool isExact)
    void clickText(parse p)
    parse[] getChatText()
    parse[] getAllText()
-   parse findTextInParse(parse[] p, String t)
+   parse findTextInParse(parse[] p, String t, bool isExact)
 I recommend not using the below functions unless you're modifying lua library functions.
    void srStripScreen()

← Older revision		Revision as of 08:39, 8 May 2012
Line 149:		Line 149:

	This draws the VeggieTales UI, any queued up lsPrint, buttons, etc. So, if you want the user to see anything, it needs to be called. Just drawing text over and over in a loop won't ever show up on screen unless lsDoFrame(); is called.		This draws the VeggieTales UI, any queued up lsPrint, buttons, etc. So, if you want the user to see anything, it needs to be called. Just drawing text over and over in a loop won't ever show up on screen unless lsDoFrame(); is called.
		+
		+	==Text Recongition Notes==
		+	See [[User:Skyfeather/VT_OCR\|Skyfeather's OCR Notes]]

@@ Line 22: / Line 22: @@
 the ATITD window, so srGetWindowSize() gets the width and height of the ATITD
 window.
 * Note that you *MUST* call srReadScreen to update the screen before calling srFindImageInRange etc.
@@ Line 57: / Line 59: @@
    Vec2[] lsAnalyzeSilt(int minsize, int maxsize, int debug, int relevant_radius)
    [l,t,r,b] srGetWindowBorders(int x, int y)
 === User Interface ===
    int lsScreenX

@@ Line 101: / Line 101: @@
-== Misc Info ==
+== Misc Notes ==
-Explanation of <b><i>tol</i></b> (tolerance) value in <b>srFindImage()</b> and <b>srFindImageInRange()</b>
+===Explanation of <b><i>tol</i></b> (tolerance) value in <b>srFindImage()</b> and <b>srFindImageInRange()</b>===
-<b>Me:</b> Can you explain how the tolerance range works for something like srFindImage("waterw.png", 1) . I've seen it range from 1 to 5000, how does the range work?
+<b>Me:</b> Can you explain how the tolerance range works srFindImage("waterw.png", 1) . I've seen it range from 1 to 5000, how does the range work?
 <b>Jimbly:</b> srFindImage looks for a block of pixels similar to the specified image, where no pixel has a summed squared difference larger than the tolerance. A tolerance of 0 or 1 would require an exact pixel for pixel match, whereas a larger tolerance would allow for mild variation (most often the background behind the text is different, since ATITD has a textured background behind windows).
@@ Line 115: / Line 115: @@
 <b>Jimbly:</b> I've found things that use a low tolerance are much more likely to break (most common being if, say, another line of text is added to a window, the tolerance of 1 will certainly not find what its looking for anymore, where as a higher tolerance will find it even if it's lower on the screen (and has slightly different background behind the text).
-Summary: Its probably safer to start out leaving the tolerance blank (default of 4500) unless you have a specific need to find something precise down to the last pixel. ie use srFindImage("Harvest.png"); instead of srFindImage("Harvest.png", 1); If you have a need to narrow down a search to be more precise, then start adding numbers to the tol value.
+===lsDoFrame()===