System Reference Summary : 3. System Classes : SpriteDescriptor Class : SpriteDescriptor Methods
 
Share this page                  
SpriteDescriptor Methods
Method
Return
Value
Description
Inherited
From
ApplySectorMap
(targetfield =
ActiveField
[, descriptors = array of SpriteDescriptor])
integer
Specifies the unit of measurement of the sprite's y-location
Defined
ApplySpriteMap
(targetfield =
ActiveField
[, descriptors = array of SpriteDescriptor]
[, operation = varchar(32)])
integer
Displays the sprites defined by an array of populated SpriteDescriptor objects on the field background
Defined
Populate
(string =
StringObject
[,indx = integer]
[, spritesource = BitmapObject])
integer
Populates a SpriteDescriptor object's attributes with the properties encoded in a sprite's descriptor string
Defined
Duplicate()
UserObject
Makes a duplicate of the object, placing a reference to the new object in a reference variable
UserObject
GetAttribute
(
attributename = byref(variable)
{,attributename = byref(variable)})
integer
Gets the values of any number of attributes for the object
UserObject
IsA
(class =
classname)
integer
Returns TRUE if the object is of the same class as, or one of the subclasses of, the class specified by classname
UserObject
SetAttribute
(
attributename = value
{,attributename = value})
integer
Sets any number of attributes for the object
UserObject
SpriteMap
(
[descriptors = array of SpriteDescriptor]
[, operation = varchar(32)])
StringObject
Returns a spritemap string, suitable for use as an UpdBackground spritemap parameter, from a set of descriptors
Defined
SpriteImage
(displayfield =
ActiveField
[, spritesource = Byref(BitmapObject)]
[, displayedsprite = Byref(BitmapObject)]
[, x = Byref(integer)]
[, y = Byref(integer)])
BitmapObject
Returns the sprite corresponding to this sprite descriptor (curobject)
Defined
SpriteKey
(action =
integer,
modifierkey = integer,
responsecode = integer)
varchar(32)
Creates a lookup key to store or access a response
Defined
WhichSprite
(displayfield =
ActiveField
[, spriteindex = integer]
[, x = integer, y = integer])
integer
Populates the host sprite descriptor (curobject) with details about the sprite identified by the passed index or x,y location
Defined
WhichSector
(displayfield =
ActiveField
[, sectorindex = integer]
[, x = integer, y = integer])
integer
Populates the host descriptor (curobject) with details about the sector, identified by the passed index or x,y location
Defined