Difference between revisions of "AGIWiki/right.posn"

From ScummVM :: Wiki
Jump to navigation Jump to search
m
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 ==

Revision as of 14:12, 1 February 2015

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

<syntax type="C++">

if (right.posn(o1, 0, 120, 60, 130)) {
  print("the object's lower right corner is in the box");
}

</syntax>

Technical Information

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

See Also

Sources