AGIWiki/obj.in.box

Test commands equaln equalv lessn lessv greatern greaterv isset issetv has obj.in.room posn controller have.key said compare.strings obj.in.box center.posn right.posn

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

• posn
• right.posn
• center.posn

Sources

• WinAGI help file