Difference between revisions of "AGIWiki/right.posn"

From ScummVM :: Wiki
Jump to navigation Jump to search
m (Created page with "__NOTOC__ {{AGIWiki}} The '''right.posn''' command returns TRUE if the screen coordinates of the screen object's bottom right pixel is within a specified region. ---- == Syntax...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{AGIWiki}}
 
{{AGIWiki}}
 +
{{AGIWiki/Test commands}}
 
The '''right.posn''' command returns TRUE if the screen coordinates of the screen object's bottom right pixel is within a specified region.
 
The '''right.posn''' command returns TRUE if the screen coordinates of the screen object's bottom right pixel is within a specified region.
 
----
 
  
 
== Syntax ==
 
== Syntax ==
Line 15: Line 14:
 
The region to be tested is bounded by (X1, Y1) - (X2, Y2).
 
The region to be tested is bounded by (X1, Y1) - (X2, Y2).
  
The position test commands ('''[[AGIWiki/posn|posn]]''', '''[[AGIWiki/center.posn|center.posn]]''', '''right.posn''', and '''[[AGIWiki/obj.in.box|obj.in.box]]''' are used to determine if a screen object's position is within a certain area.
+
The position test commands ('''[[AGIWiki/posn|posn]]''', '''[[AGIWiki/center.posn|center.posn]]''', '''right.posn''', and '''[[AGIWiki/obj.in.box|obj.in.box]]''') are used to determine if a screen object's position is within a certain area.
  
 
== Example ==
 
== Example ==
<syntax type="C++">
+
<syntaxhighlight lang="cpp">
 
  if (right.posn(o1, 0, 120, 60, 130)) {
 
  if (right.posn(o1, 0, 120, 60, 130)) {
 
   print("the object's lower right corner is in the box");
 
   print("the object's lower right corner is in the box");
 
  }
 
  }
</syntax>
+
</syntaxhighlight>
 +
 
 
== Technical Information ==
 
== Technical Information ==
  

Latest revision as of 15:17, 25 October 2018

AGIWiki


Test commands

The right.posn command returns TRUE if the screen coordinates of the screen object's bottom right pixel is within a specified region.

Syntax

right.posn(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 (right.posn(o1, 0, 120, 60, 130)) {
   print("the object's lower right corner is in the box");
 }

Technical Information

Required interpreter version Available in all AGI versions
Bytecode value 18 (0x12 hex)

See Also

Sources