SetMainBackground
SetMainBackground

Sets the main background of the JAM object.

bSuccess = myJAM.SetMainBackground( Image_Index )
bSuccess = myJAM.SetMainBackground( Image_Name )
bSuccess = myJAM.SetMainBackground( Surface )

Return value
TRUE if the background was set successfully, otherwise FALSE.

Parameters
  • Image_Index
    The index number of a picture in the Pictures bank to use as the background
  • Image_Name
    The name of a picture in the Pictures bank to use as the background
  • Surface
    A surface object to use as the background
Comments

Unlike other backgrounds, the Main background does not tile, and always scrolls at a speed of 1.0 x 1.0
PasteIntoBackground pastes objects into this surface, so if it is too small, the pasted object will not be visible.

See also
JAM:GetMainBackground
JAM:SetCollisionMask
JAM:NewBackground



JAM © 2005 no one in partiular
Project started by David Evans in 2005