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

From ScummVM :: Wiki
Jump to navigation Jump to search
(→‎Example: Fix syntax highlighting)
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(One intermediate revision by the same user not shown)
Line 19: Line 19:
  
 
== Example ==
 
== Example ==
<source lang="cpp">
+
<syntaxhighlight lang="cpp">
 
  if (obj.in.box(o1, 0, 120, 60, 130)) {
 
  if (obj.in.box(o1, 0, 120, 60, 130)) {
 
   print("the object's entire bottom row is in the box");
 
   print("the object's entire bottom row is in the box");
 
  }
 
  }
</source>
+
</syntaxhighlight>
  
 
== Technical Information ==
 
== Technical Information ==

Latest revision as of 15:12, 25 October 2018

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

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

Technical Information

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

See Also

Sources