Types

Types

Description

DESCRIPTION

Details

AccelerometerMotion

Structure Field List:
xAxis : Longint
yAxis : Longint
zAxis : Longint

AnimationData

Structure Field List:
firstFrame : AnimationFrame
currentFrame : AnimationFrame
lastFrame : AnimationFrame
frameTime : Single
enteredFrame : Boolean
script : AnimationScript
animationName : String

AnimationFrame


AnimationFrameData

Structure Field List:
index : Longint
cellIndex : Longint
sound : SoundEffect
duration : Single
movement : Vector
next : AnimationFrame

AnimationScriptData

Structure Field List:
name : String
filename : String
animationIds : NamedIndexCollection
animations : LongintArray
frames : AnimationFrame[0..n - 1]
animObjs : Pointer[0..n - 1]
nextAnimIdx : Longint

ArduinoData

Structure Field List:
name : String
ptr : Pointer
port : String
baud : Longint
open : Boolean
hasError : Boolean
errorMessage : String

BitmapData

Bitmap data stores the data associated with a Bitmap. Each bitmap contains a pointer to the bitmap color information (surface), its width, height, and a mask storing the non-transparent pixels that is used for pixel level collision checking.

Structure Field List:
filename : String
name : String
surface : Pointer
width : Longint
height : Longint
TextureWidthRatio : Single
TextureHeightRatio : Single
cellW : Longint
cellH : Longint
cellCols : Longint
cellRows : Longint
cellCount : Longint
nonTransparentPixels : Boolean[0..n - 1][0..n - 1]
clipStack : Rectangle[0..n - 1]

CharacterData

Structure Field List:
Name : String
FileName : String
CharSprite : Sprite
CharName : String
CharType : String
States : NamedIndexCollection
Directions : NamedIndexCollection
CurrentState : Longint
CurrentDirection : Longint
DirectionParameters : DirectionAngles[0..n - 1]
ShownLayers : Boolean[0..n - 1]
ShownLayersByDirState : DirStateData[0..n - 1][0..n - 1]
ShownLayerCache : Longint[0..n - 1][0..n - 1][0..n - 1]

CollisionSide

The CollisionSide enumeration is used to indicate the side a collision has occurred on.

Enumerated Values:
Top
Bottom
Left
Right
TopLeft
TopRight
BottomLeft
BottomRight
None

CollisionTestKind

Enumerated Values:
PixelCollisions
AABBCollisions


Color

The color type is used within the SwinGameAPI to store color values. The color values are represented as 32bit RGBA values where R stores the color's red component, G stores the green component, B stores the blue component and A stores an alpha value representing the opacity (transparency) of the of the color.


Used by:
BlueOf BrightnessOf CalculateFramerate ClearScreenTo ClearSurface ColorComponents ColorFromBitmap ColorToString DrawCircle DrawCircleAtPoint DrawCircleAtPointOnScreen DrawCircleAtPointOnto DrawCircleOnScreen DrawCircleOnto DrawCircleStruct DrawCircleStructOnScreen DrawCircleStructOnto DrawEllipse DrawEllipseInRect DrawEllipseInRectOnScreen DrawEllipseInRectOnto DrawEllipseOnScreen DrawEllipseOnto DrawHorizontalLine DrawHorizontalLineOnScreen DrawHorizontalLineOnto DrawLine DrawLineOnScreen DrawLineOnto DrawLinePts DrawLinePtsOnScreen DrawLinePtsOnto DrawLineSegment DrawLineSegmentOnScreen DrawLineSegmentOnto DrawLineSegments DrawOrFillCircle DrawOrFillCircleAtPoint DrawOrFillCircleAtPointOnScreen DrawOrFillCircleAtPointOnto DrawOrFillCircleOnScreen DrawOrFillCircleOnto DrawOrFillCircleStruct DrawOrFillCircleStructOnScreen DrawOrFillCircleStructOnto DrawOrFillEllipse DrawOrFillEllipseInRect DrawOrFillEllipseInRectOnScreen DrawOrFillEllipseInRectOnto DrawOrFillEllipseOnScreen DrawOrFillEllipseOnto DrawOrFillRectangle DrawOrFillRectangleOnScreen DrawOrFillRectangleOnto DrawOrFillRectangleStruct DrawOrFillRectangleStructOnScreen DrawOrFillRectangleStructOnto DrawOrFillTriangleStruct DrawOrFillTriangleStructOnScreen DrawOrFillTriangleStructOnto DrawPixel DrawPixelAtPoint DrawPixelAtPointOnScreen DrawPixelAtPointOnto DrawPixelOnScreen DrawPixelOnto DrawRectangle DrawRectangleOnScreen DrawRectangleOnto DrawRectangleStruct DrawRectangleStructOnScreen DrawRectangleStructOnto DrawSimpleText DrawSimpleTextOnBitmap DrawSimpleTextOnScreen DrawSimpleTextPt DrawText DrawTextAtPoint DrawTextAtPointWithFontNamed DrawTextAtPointWithFontNamedAndSize DrawTextLines DrawTextLinesInRect DrawTextLinesInRectOnBitmap DrawTextLinesInRectOnBitmapWithFontNamed DrawTextLinesInRectOnBitmapWithFontNamedAndSize DrawTextLinesInRectOnScreen DrawTextLinesInRectOnScreenWithFontNamed DrawTextLinesInRectOnScreenWithFontNamedAndSize DrawTextLinesInRectWithFontNamed DrawTextLinesInRectWithFontNamedAndSize DrawTextLinesOnBitmap DrawTextLinesOnBitmapWithFontNamed DrawTextLinesOnBitmapWithFontNamedAndSize DrawTextLinesOnScreen DrawTextLinesOnScreenWithFontNamed DrawTextLinesOnScreenWithFontNamedWithSize DrawTextLinesWithFontNamed DrawTextLinesWithFontNamedAndSize DrawTextOnBitmap DrawTextOnBitmapAtPoint DrawTextOnBitmapAtPointWithFontNamed DrawTextOnBitmapAtPointWithFontNamedAndSize DrawTextOnBitmapWithFontNamed DrawTextOnBitmapWithFontNamedAndSize DrawTextOnScreen DrawTextOnScreenAtPoint DrawTextOnScreenAtPointWithFontNamed DrawTextOnScreenAtPointWithFontNamedAndSize DrawTextOnScreenWithFontNamed DrawTextOnScreenWithFontNamedAndSize DrawTextToBitmapAtPointWithFontNamedAndSize DrawTextWithFontNamed DrawTextWithFontNamedSize DrawThickLine DrawTriangle DrawTriangleOnScreen DrawTriangleOnto DrawTriangleStruct DrawTriangleStructOnScreen DrawTriangleStructOnto DrawVerticalLine DrawVerticalLineOnScreen DrawVerticalLineOnto FillCircle FillCircleAtPoint FillCircleAtPointOnScreen FillCircleAtPointOnto FillCircleOnScreen FillCircleOnto FillCircleStruct FillCircleStructOnScreen FillCircleStructOnto FillEllipse FillEllipseInRect FillEllipseInRectOnScreen FillEllipseInRectOnto FillEllipseOnScreen FillEllipseOnto FillRectangle FillRectangleOnScreen FillRectangleOnto FillRectangleStruct FillRectangleStructOnScreen FillRectangleStructOnto FillTriangle FillTriangleOnScreen FillTriangleOnto FillTriangleStruct FillTriangleStructOnScreen FillTriangleStructOnto GUISetBackgroundColor GUISetBackgroundColorInactive GUISetForegroundColor GUISetForegroundColorInactive GreenOf HSBValuesOf HueOf LoadBitmapWithTransparentColor LoadTransparentBitmap LoadTransparentBitmapNamed PutPixel RedOf SaturationOf SetTransparentColor StartReadingText StartReadingTextWithText StartReadingTextWithTextAndColorInArea StartReadingTextWithTextAtPt StartReadingTextWithTextInArea StartReadingTextWithinArea TransparencyOf

ConnectionData

Structure Field List:
socket : Pointer
ip : Longword
port : Longint
firstMsg : MessagePtr
lastMsg : MessagePtr
msgCount : Longint
isTCP : Boolean
msgLen : Longint
partMsgData : String

DirStateData

The DirStateData contains the data for a Character's direction and state combination. This allows, for example, for a character to have an animation and layer orderring for Swimming North, Walking North, Swimming East, etc.

Structure Field List:
Anim : Longint
LayerOrder : LongintArray

DirectionAngles

Character directions are represented as existing between a given minimum and maximum angle as coded in the DirectionAngles type. This is then used with the velocity from the Character's Sprite to determine the image that is shown.

Structure Field List:
min : Longint
max : Longint

EventKind

The Event kind is an enum of all the events that could happen to a gui element

Enumerated Values:
ekClicked
ekTextEntryEnded
ekSelectionMade

FileDialogSelectType

The file dialog select type is an enum of how a file dialog displays files/directories

Enumerated Values:
fdFiles = 1
fdDirectories = 2
fdFilesAndDirectories = 3


Finger

Structure Field List:
id : Int64
position : Point2D
positionDelta : Point2D
lastPosition : Point2D
pressure : Single
down : Boolean

FingerArray


FontData

Structure Field List:
fptr : Pointer
name : String

FontStyle

Use font styles to set the style of a font. Setting the style is time consuming, so create alternative font variables for each different style you want to work with. Note that these values can be logical ORed together to combine styles, e.g. BoldFont or ItalicFont = both bold and italic.

Enumerated Values:
NormalFont = 0
BoldFont = 1
ItalicFont = 2
UnderlineFont = 4

Used by:
FontSetStyle

FreeNotifier

The FreeNotifier is a function pointer used to notify user programs of swingame resources being freed. This should not be used by user programs.



GUICheckboxData

Structure Field List:
state : Boolean

GUIElementKind

GUIElementKind is an enum of all the GUI types

Enumerated Values:
gkLabel = 1
gkButton = 2
gkCheckBox = 4
gkRadioGroup = 8
gkTextBox = 16
gkList = 32
gkAnyKind = 63


GUIEventCallback

GUIEventCallback is a callbackfunction for gui eventsin swingame



GUILabelData

Structure Field List:
contentString : String
font : Font
alignment : FontAlignment

GUIListData

Structure Field List:
verticalScroll : Boolean
scrollUp : Rectangle
scrollDown : Rectangle
scrollArea : Rectangle
columns : Longint
rows : Longint
rowHeight : Longint
colWidth : Longint
scrollSize : Longint
placeholder : Rectangle[0..n - 1]
activeItem : Longint
startingAt : Longint
font : Font
items : GUIListItem[0..n - 1]
scrollButton : Bitmap
alignment : FontAlignment

GUIListItem

Each list item has text and an image

Structure Field List:
text : String
image : BitmapCell
parent : GUIList

GUIRadioGroupData

Structure Field List:
groupID : String
buttons : Region[0..n - 1]
activeButton : Longint

GUITextboxData

Structure Field List:
contentString : String
font : Font
lengthLimit : Longint
forRegion : Region
alignment : FontAlignment

KeyCode

Enumerated Values:
vk_Unknown = 0
vk_BACKSPACE = 8
vk_TAB = 9
vk_CLEAR = 12
vk_RETURN = 13
vk_PAUSE = 19
vk_ESCAPE = 27
vk_SPACE = 32
vk_EXCLAIM = 33
vk_QUOTEDBL = 34
vk_HASH = 35
vk_DOLLAR = 36
vk_AMPERSAND = 38
vk_QUOTE = 39
vk_LEFTPAREN = 40
vk_RIGHTPAREN = 41
vk_ASTERISK = 42
vk_PLUS = 43
vk_COMMA = 44
vk_MINUS = 45
vk_PERIOD = 46
vk_SLASH = 47
vk_0 = 48
vk_1 = 49
vk_2 = 50
vk_3 = 51
vk_4 = 52
vk_5 = 53
vk_6 = 54
vk_7 = 55
vk_8 = 56
vk_9 = 57
vk_COLON = 58
vk_SEMICOLON = 59
vk_LESS = 60
vk_EQUALS = 61
vk_GREATER = 62
vk_QUESTION = 63
vk_AT = 64
vk_LEFTBRACKET = 91
vk_BACKSLASH = 92
vk_RIGHTBRACKET = 93
vk_CARET = 94
vk_UNDERSCORE = 95
vk_BACKQUOTE = 96
vk_a = 97
vk_b = 98
vk_c = 99
vk_d = 100
vk_e = 101
vk_f = 102
vk_g = 103
vk_h = 104
vk_i = 105
vk_j = 106
vk_k = 107
vk_l = 108
vk_m = 109
vk_n = 110
vk_o = 111
vk_p = 112
vk_q = 113
vk_r = 114
vk_s = 115
vk_t = 116
vk_u = 117
vk_v = 118
vk_w = 119
vk_x = 120
vk_y = 121
vk_z = 122
vk_DELETE = 127
vk_WORLD_0 = 160
vk_WORLD_1 = 161
vk_WORLD_2 = 162
vk_WORLD_3 = 163
vk_WORLD_4 = 164
vk_WORLD_5 = 165
vk_WORLD_6 = 166
vk_WORLD_7 = 167
vk_WORLD_8 = 168
vk_WORLD_9 = 169
vk_WORLD_10 = 170
vk_WORLD_11 = 171
vk_WORLD_12 = 172
vk_WORLD_13 = 173
vk_WORLD_14 = 174
vk_WORLD_15 = 175
vk_WORLD_16 = 176
vk_WORLD_17 = 177
vk_WORLD_18 = 178
vk_WORLD_19 = 179
vk_WORLD_20 = 180
vk_WORLD_21 = 181
vk_WORLD_22 = 182
vk_WORLD_23 = 183
vk_WORLD_24 = 184
vk_WORLD_25 = 185
vk_WORLD_26 = 186
vk_WORLD_27 = 187
vk_WORLD_28 = 188
vk_WORLD_29 = 189
vk_WORLD_30 = 190
vk_WORLD_31 = 191
vk_WORLD_32 = 192
vk_WORLD_33 = 193
vk_WORLD_34 = 194
vk_WORLD_35 = 195
vk_WORLD_36 = 196
vk_WORLD_37 = 197
vk_WORLD_38 = 198
vk_WORLD_39 = 199
vk_WORLD_40 = 200
vk_WORLD_41 = 201
vk_WORLD_42 = 202
vk_WORLD_43 = 203
vk_WORLD_44 = 204
vk_WORLD_45 = 205
vk_WORLD_46 = 206
vk_WORLD_47 = 207
vk_WORLD_48 = 208
vk_WORLD_49 = 209
vk_WORLD_50 = 210
vk_WORLD_51 = 211
vk_WORLD_52 = 212
vk_WORLD_53 = 213
vk_WORLD_54 = 214
vk_WORLD_55 = 215
vk_WORLD_56 = 216
vk_WORLD_57 = 217
vk_WORLD_58 = 218
vk_WORLD_59 = 219
vk_WORLD_60 = 220
vk_WORLD_61 = 221
vk_WORLD_62 = 222
vk_WORLD_63 = 223
vk_WORLD_64 = 224
vk_WORLD_65 = 225
vk_WORLD_66 = 226
vk_WORLD_67 = 227
vk_WORLD_68 = 228
vk_WORLD_69 = 229
vk_WORLD_70 = 230
vk_WORLD_71 = 231
vk_WORLD_72 = 232
vk_WORLD_73 = 233
vk_WORLD_74 = 234
vk_WORLD_75 = 235
vk_WORLD_76 = 236
vk_WORLD_77 = 237
vk_WORLD_78 = 238
vk_WORLD_79 = 239
vk_WORLD_80 = 240
vk_WORLD_81 = 241
vk_WORLD_82 = 242
vk_WORLD_83 = 243
vk_WORLD_84 = 244
vk_WORLD_85 = 245
vk_WORLD_86 = 246
vk_WORLD_87 = 247
vk_WORLD_88 = 248
vk_WORLD_89 = 249
vk_WORLD_90 = 250
vk_WORLD_91 = 251
vk_WORLD_92 = 252
vk_WORLD_93 = 253
vk_WORLD_94 = 254
vk_WORLD_95 = 255
vk_KP0 = 256
vk_KP1 = 257
vk_KP2 = 258
vk_KP3 = 259
vk_KP4 = 260
vk_KP5 = 261
vk_KP6 = 262
vk_KP7 = 263
vk_KP8 = 264
vk_KP9 = 265
vk_KP_PERIOD = 266
vk_KP_DIVIDE = 267
vk_KP_MULTIPLY = 268
vk_KP_MINUS = 269
vk_KP_PLUS = 270
vk_KP_ENTER = 271
vk_KP_EQUALS = 272
vk_UP = 273
vk_DOWN = 274
vk_RIGHT = 275
vk_LEFT = 276
vk_INSERT = 277
vk_HOME = 278
vk_END = 279
vk_PAGEUP = 280
vk_PAGEDOWN = 281
vk_F1 = 282
vk_F2 = 283
vk_F3 = 284
vk_F4 = 285
vk_F5 = 286
vk_F6 = 287
vk_F7 = 288
vk_F8 = 289
vk_F9 = 290
vk_F10 = 291
vk_F11 = 292
vk_F12 = 293
vk_F13 = 294
vk_F14 = 295
vk_F15 = 296
vk_NUMLOCK = 300
vk_CAPSLOCK = 301
vk_SCROLLOCK = 302
vk_RSHIFT = 303
vk_LSHIFT = 304
vk_RCTRL = 305
vk_LCTRL = 306
vk_RALT = 307
vk_LALT = 308
vk_RMETA = 309
vk_LMETA = 310
vk_LSUPER = 311
vk_RSUPER = 312
vk_MODE = 313
vk_COMPOSE = 314
vk_HELP = 315
vk_PRINT = 316
vk_SYSREQ = 317
vk_BREAK = 318
vk_MENU = 319
vk_POWER = 320
vk_EURO = 321


LongintArray


Matrix2D

In SwinGame, Matrices can be used to combine together a number of operations that need to be performed on Vectors.

Structure Field List:
elements : Single[0..2][0..2]


MessagePtr

The Pointer to a MessageLink Creating a String LinkedList


MouseButton

A mouse can have many different types of buttons. Most people know about the simple Left and Right buttons, but there is also a Middle button (sometimes part of a scoll wheel). Scroll wheel movement is also treated as mouse button "clicks" of either the wheel "up" or "down" buttons.

Enumerated Values:
NoButton
LeftButton
MiddleButton
RightButton
WheelUpButton
WheelDownButton
MouseX1Button
MouseX2Button


MusicData

Structure Field List:
music : Pointer
filename : String
name : String

NamedIndexCollection

The named index collection type is used to maintain a named collection of index values that can then be used to lookup the location of the named value within a collection.

Structure Field List:
names : StringArray
ids : Pointer

PanelData

Structure Field List:
name : String
filename : String
panelID : Longint
area : Rectangle
visible : Boolean
active : Boolean
draggable : Boolean
panelBitmap : Bitmap
panelBitmapInactive : Bitmap
panelBitmapActive : Bitmap
regions : RegionData[0..n - 1]
regionIds : NamedIndexCollection
labels : GUILabelData[0..n - 1]
checkBoxes : GUICheckboxData[0..n - 1]
radioGroups : GUIRadioGroupData[0..n - 1]
textBoxes : GUITextboxData[0..n - 1]
lists : GUIListData[0..n - 1]
modal : Boolean
DrawAsVectors : Boolean

Point2D

A Point2D represents an location in Cartesian coordinates (x,y).

Structure Field List:
x : Single
y : Single

Used by:
BitmapAtPointsCollision BitmapCellCircle BitmapCellRectangle BitmapCircle BitmapPartAtPtRectCollision BitmapPartPointXYCollision BitmapPointPtCollision BitmapsPartsCollision CalculateAngleBetween CellBitmapCollisionAtPt CellBitmapPartCollisionAtPt CellCollisionAtPt CellRectCollisionAtPt CircleAt ClosestPointOnCircle ClosestPointOnLine CreateBasicSpritePt CreateCircle CreateLinePointToPoint CreateLineVectorWithStartPoint CreateRectangleAtPoint CreateRectangleForPoints CreateSpriteWithAnimationPt CreateTrianglePoints CreateVectorFromPointPtToRectangle CreateVectorFromPoints CreateVectorToPoint DistantPointOnCircle DistantPointOnCircleHeading DrawAnimationAtPoint DrawAnimationOnScreenAtPt DrawAnimationOntoDestAtPt DrawBitmapAtPoint DrawBitmapAtPointOnScreen DrawBitmapAtPointOnto DrawBitmapCellAtPoint DrawBitmapCellAtPointOnScreen DrawBitmapCellAtPointOnto DrawBitmapNamedAtPoint DrawBitmapPartFromRectAtPoint DrawBitmapPartFromRectAtPointOnScreen DrawBitmapPartFromRectAtPointOnto DrawCell DrawCellOnScreen DrawCellOnto DrawCircleAtPoint DrawCircleAtPointOnScreen DrawCircleAtPointOnto DrawLinePts DrawLinePtsOnScreen DrawLinePtsOnto DrawOrFillCircleAtPoint DrawOrFillCircleAtPointOnScreen DrawOrFillCircleAtPointOnto DrawPixelAtPoint DrawPixelAtPointOnScreen DrawPixelAtPointOnto DrawSimpleTextPt DrawSpriteOffsetPoint DrawTextAtPoint DrawTextAtPointWithFontNamed DrawTextAtPointWithFontNamedAndSize DrawTextOnBitmapAtPoint DrawTextOnBitmapAtPointWithFontNamed DrawTextOnBitmapAtPointWithFontNamedAndSize DrawTextOnScreenAtPoint DrawTextOnScreenAtPointWithFontNamed DrawTextOnScreenAtPointWithFontNamedAndSize FillCircleAtPoint FillCircleAtPointOnScreen FillCircleAtPointOnto LineFromPointToPoint LineFromVectorWithStartPoint LineIntersectionPoint MoveCameraTo MoveMouseToPoint PanelAtPoint PointAdd PointAtStartWithOffset PointInCircle PointInCirclePt PointInRect PointInRectXY PointInRegion PointInRegionWithKind PointInTriangle PointLineDistance PointOnLine PointOnLineXYXY PointOnPoint PointOnScreen PointPointDistance PointToString RayCircleIntersectDistance RayIntersectionPoint RectangleAtPoint RectangleForPoints RegionAtPoint ScaleMatrixByPoint ScaleRotateTranslateMatrix SetCameraPos SpriteBitmapAtPointCollision SpriteMoveTo SpriteOnScreenAtPoint SpriteSetLayerOffset SpriteSetLayerOffsetNamed SpriteSetPosition StartReadingTextWithTextAtPt TangentPoints ToScreen ToWorld TranslationMatrixPt TriangleFromPoints VectorFromCenterSpriteToPoint VectorFromPointPtToRectangle VectorFromPoints VectorOutOfCircleFromPoint VectorOutOfRectFromPoint VectorToPoint WidestPoints

Point2DArray



Rectangle

Structure Field List:
x : Single
y : Single
width : Longint
height : Longint

Used by:
BitmapPartAtPtRectCollision BitmapPartPointCollision BitmapPartPointXYCollision BitmapPartRectCollision BitmapRectangleCollision BitmapsPartsCollision CellBitmapPartCollision CellBitmapPartCollisionAtPt CellRectCollision CellRectCollisionAtPt CircleRectCollision CircleWithinRect ClosestPointOnRectFromCircle CollideCircleRectangle CreateVectorFromPointPtToRectangle CreateVectorFromPointToRectangle DrawBitmapPartFromRect DrawBitmapPartFromRectAtPoint DrawBitmapPartFromRectAtPointOnScreen DrawBitmapPartFromRectAtPointOnto DrawBitmapPartFromRectOnScreen DrawBitmapPartFromRectOnto DrawEllipseInRect DrawEllipseInRectOnScreen DrawEllipseInRectOnto DrawOrFillEllipseInRect DrawOrFillEllipseInRectOnScreen DrawOrFillEllipseInRectOnto DrawOrFillRectangleStruct DrawOrFillRectangleStructOnScreen DrawOrFillRectangleStructOnto DrawRectangleStruct DrawRectangleStructOnScreen DrawRectangleStructOnto DrawTextLinesInRect DrawTextLinesInRectOnBitmap DrawTextLinesInRectOnBitmapWithFontNamed DrawTextLinesInRectOnBitmapWithFontNamedAndSize DrawTextLinesInRectOnScreen DrawTextLinesInRectOnScreenWithFontNamed DrawTextLinesInRectOnScreenWithFontNamedAndSize DrawTextLinesInRectWithFontNamed DrawTextLinesInRectWithFontNamedAndSize FillEllipseInRect FillEllipseInRectOnScreen FillEllipseInRectOnto FillRectangleStruct FillRectangleStructOnScreen FillRectangleStructOnto FixRectangle InsetRectangle Intersection LineIntersectsRect LinesFromRect LinesRectIntersect PointInRect PointXYInRect PointsFromRect PushClipRect PushClipRectForBitmap RectLineCollision RectOnScreen RectangleAfterMove RectangleBottom RectangleBottomLeft RectangleBottomRight RectangleCenter RectangleCenterBottom RectangleCenterLeft RectangleCenterRight RectangleCenterTop RectangleLeft RectangleOffset RectangleRight RectangleToString RectangleTop RectangleTopLeft RectangleTopRight RectanglesIntersect SetBmpClip SetClip SpriteRectangleCollision StartReadingTextWithTextAndColorInArea StartReadingTextWithTextInArea StartReadingTextWithinArea ToScreenRect TriangleRectangleIntersect TrianglesRectangleIntersect VectorFromPointPtToRectangle VectorFromPointToRectangle VectorInRect VectorOutOfRectFromCircle VectorOutOfRectFromPoint VectorOutOfRectFromRect

RegionData

Structure Field List:
stringID : String
kind : GUIElementKind
regionIdx : Longint
elementIndex : Longint
area : Rectangle
active : Boolean
parent : Panel
callbacks : GUIEventCallback[0..n - 1]

Resolution

Structure Field List:
format : Word
refreshRate : Longint
width : Longint
height : Longint

ResolutionArray


ResourceKind

Use this with the resource path functions to get the path to a given resource. Using these functions ensures that your resource paths are correct across different platforms

Enumerated Values:
BundleResource
TimerResource
BitmapResource
FontResource
MusicResource
MapResource
SoundResource
AnimationResource
PanelResource
CharacterResource
OtherResource


SingleArray


SoundEffectData

Structure Field List:
effect : Pointer
filename : String
name : String

SpriteData

Structure Field List:
name : String
layerIds : NamedIndexCollection
layers : BitmapArray
visibleLayers : LongintArray
layerOffsets : Point2DArray
values : SingleArray
valueIds : NamedIndexCollection
animationInfo : Animation
animationScript : AnimationScript
position : Point2D
velocity : Vector
collisionKind : CollisionTestKind
collisionBitmap : Bitmap
backupCollisionBitmap : Bitmap
cacheImage : Bitmap
isMoving : Boolean
destination : Point2D
movingVec : Vector
arriveInSec : Single
lastUpdate : Longint
announcedAnimationEnd : Boolean
evts : SpriteEventHandlerArray
pack : Pointer

SpriteEventHandler

The SpriteEventHandler function pointer is used when you want to register to receive events from a Sprite.



SpriteEventHandlerArray

An array of SpriteEventHandlers used internally by Sprites.

  • source code
  • type: wraps_array: SpriteEventHandler[0..n - 1]

SpriteEventKind

This enumeration contains a list of all of the different kinds of events that a Sprite can raise. When the event is raised the assocated SpriteEventKind value passed to the event handler to indicate the kind of event that has occurred.

Enumerated Values:
SpriteArrivedEvent
SpriteAnimationEndedEvent
SpriteTouchedEvent
SpriteClickedEvent

SpriteFunction

SpriteFunctions are used with SpritePacks to provide a procedure to be called for each of the Sprites in the SpritePack.



SpriteSingleFunction

SpriteSingleFunctions are used with SpritePacks to provide a procedure to be called for each of the Sprites in the SpritePack. This version allows a single value to be passed as a parameter along with the call.


TimerData

Structure Field List:
startTicks : Longword
pausedTicks : Longword
paused : Boolean
started : Boolean
name : String

TriangleArray