Lingo Dictionary > S > sprite...within |  |

sprite...within

Syntax

    sprite(sprite1).within(sprite2)
    sprite sprite1 within sprite2

Description

Keyword; operator that compares the position of two sprites and determines whether the quad of `sprite1` is entirely inside the quad of `sprite2` (`TRUE`) or not (`FALSE`).

If both sprites have matte ink, their actual outlines, not the quads, are used. A sprite's outline is defined by the nonwhite pixels that make up its border.

This is a comparison operator with a precedence level of 5.

Note: The dot operator is required whenever sprite1 is not a simple expression—that is, one that contains a math operation.

Example

This statement checks whether two sprites intersect and calls the handler `doInside` if they do:

    if sprite(3).within(2) then doInside

See also

`sprite...intersects, quad`