System Reference Summary : 3. System Classes : SpriteDescriptor Class
 
Share this page                  
SpriteDescriptor Class
SpriteDescriptor Attributes
Attribute
Data Type
Description
Inherited From
Angle
integer
Specifies the amount the sprite image has been rotated before display. Allowed values are 0–360 degrees. (RW)
Defined
ClassName
varchar(32)
Gives the name of an object's actual type (as opposed to its declared type) (R)
UserObject
ClientData
Object
Provides a way to associate data with an object (RW)
UserObject
DescriptorString
StringObject
Specifies the text encoding equivalent to this descriptor's property settings (RW)
Defined
Flags
integer
Specifies which of the generic intrinsic behaviors apply to this sprite (RW)
Defined
Flip
integer
Specifies the reflection applied to the sprite (RW)
Defined
Gravity
varchar(2)
Specifies the reference point on the sector (if specified) or field, relative to which the location of the sprite is defined (RW)
Defined
Height
integer
Specifies the height of the sprite in pixels or as percentage of the field height (RW)
Defined
HeightUnit
varchar(32)
Specifies the unit of measurement of the sprite's displayed height (RW)
Defined
InstanceIdentifier
integer8
Contains a value that uniquely identifies an instance of an allocated object (R)
UserObject
InstanceReferences
integer
Contains the current number of references to the object (R)
UserObject
Name
varchar(256)
Specifies the text name or other identification characterizing this sprite (RW)
Defined
Opacity
float
Specifies the percentage of opacity for the sprite when drawn onto the background of the field (RW)
Defined
PropertyString
StringObject
Specifies the string version corresponding to this descriptor. It is automatically generated when the SpriteDescriptor is populated. (R)
Defined
Response
integer
Specifies the intrinsic or user-defined behavior this sprite will exhibit when triggered (RW)
Defined
Sector
integer
Specifies the background sector relative to which the sprite's location is defined (RW)
Defined
SpriteIndex
integer
Defines the position of this sprite in the sequence of sprite descriptors from which the complete spritemap for this field is drawn (RW)
Defined
SpriteSource
BitmapObject
References a bitmap object corresponding to the source image identified by the SpriteSourceIndex (RW)
Defined
SpriteSourceIndex
integer
Specifies the index of the source image to be displayed as this sprite (RW)
Defined
Width
integer
Specifies the width of the sprite in pixels or as percentage of the field width (RW)
Defined
WidthUnit
varchar(32)
Specifies the unit of measurement of the sprite's displayed width (RW)
Defined
X
integer
Specifies the x-location of the sprite in pixels or as percentage of the field width (RW)
Defined
XUnit
varchar(32)
Specifies the unit of measurement of the sprite's x-location (RW)
Defined
Y
integer
Specifies the y-location of the sprite in pixels or as percentage of the field height (RW)
Defined
YUnit
varchar(32)
Specifies the unit of measurement of the sprite's y-location (RW)
Defined