# GetSpriteInScreen

## Description

Returns 1 if the sprite is currently within the visible area of the screen, 0 if it is outside the visible area. Note that if the sprite is very close to the edge where it may be difficult to determine if all the pixels in the sprite are outside the visible area then this command will return 1 and assume it is visible. In other words if this command returns 0 then the sprite is definitely off screen, if it returns 1 then the sprite is most likely on screen but could actually be off screen and very close to an edge.

## Definition

integer GetSpriteInScreen( iSpriteIndex )

int agk::GetSpriteInScreen( UINT iSpriteIndex )

## Parameters

- iSpriteIndex - The ID of the sprite to check.