Difference between revisions of "AGIWiki/obj.in.box"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (Created page with "__NOTOC__ {{AGIWiki}} The '''obj.in.box''' command returns TRUE if the entire bottom row of pixels of the screen object is within a specified region. ---- == Syntax == : obj....")
 
m
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{AGIWiki}}
 
{{AGIWiki}}
 
+
{{AGIWiki/Test commands}}
 
The '''obj.in.box''' command returns TRUE if the entire bottom row of pixels of the screen object is within a specified region.
 
The '''obj.in.box''' command returns TRUE if the entire bottom row of pixels of the screen object is within a specified region.
  

Revision as of 14:11, 1 February 2015

AGIWiki


Test commands

The obj.in.box command returns TRUE if the entire bottom row of pixels of the screen object is within a specified region.


Syntax

obj.in.box(obj oA, byt X1, byt Y1, byt X2, byt Y2)

Remarks

Test commands are only valid in an if statement.

The region to be tested is bounded by (X1, Y1) - (X2, Y2).

The position test commands (posn, center.posn, right.posn, and obj.in.box) are used to determine if a screen object's position is within a certain area.

Example

<syntax type = "C++">

if (obj.in.box(o1, 0, 120, 60, 130)) {
  print("the object's entire bottom row is in the box");
}

</syntax>

Technical Information

Required interpreter version Available in all AGI versions
Bytecode value 16 (0x10 hex)

See Also

Sources