TImage The TImage class is used to load images from the disk into the SDL engine. The images loaded can be of types PNG (reccommended), BMP, TGA, or TIFF. They must be in the power of 2 size (ex: 128x128, 96x64, 32x32, etc...). LoadFromFile(FileName) Use LoadFromFile to load an existing image from the system. Images must be in a power of two size. Can load; PNG (Reccommended), BMP, TGA and TIFF. Draw(X, Y[, PatternIndex]) Draw displays the image or image pattern at position x, y on the screen. DrawTiled(X, Y, NumRepeatX, NumRepeatY[, PatternIndex]) Draw displays the image or image pattern at position x, y NumRepeatX times wide and NumRepeatY times high. CreatePatternRects(PatternWidth, PatternHeight) Call CreatePatternRects to automatically generate pattern rectangles for an image. This is useful when you have sprite sheets or other such images that have all of the cells of equal size. PatternHeight(PatternIndex): Height Returns the height of the pattern at PatternIndex. PatternWidth(PatternIndex): Width Returns the width of the pattern at PatternIndex. PatternRect(PatternIndex): X, Y, Width, Height Returns the X, Y, Width, and Height of the pattern at PatternIndex. SetPatternRect(PatternIndex, X, Y, Width, Height) Use SetPatternRect to set a pattern rectangle for a given pattern index. Name File name or unique name for the image, you can pretty much ignore this property. ImageSurface This is the raw pointer to the SDL surface for the image. This can be used with the SDL methods that have been wrapped up in the engine. Transparent A boolean flag that is used to check if an image is transparent or set the image's transparent value. Width Full width of the image. Height Full height of the image. PatternCount Used to get the number of patterns an image has or to set the number of patterns an image should have. Must be called before SetPatternRect. MyImage = TImage:new() MyImage:LoadFromFile('Test.png') function OnRender() MyImage:Draw(0, 0) end TSprite TSprite is the base class for all sprites within the main system. It surfaces basic things such as image and pattern handeling. It can be used for static sprites and images that require basic collision. Draw(FrameTime) Draw the current sprite at its X and Y location using its current PatternIndex. SetBoundsRect(Left, Top, Right, Bottom) Set the Bounding Collision Rectangle (or Ellipse) for the sprite. Image The TImage that the sprite should use for rendering. PatternIndex PatternIndex of the Image property that should be used when the sprite is drawn. X X location of the sprite. Y Y location of the sprite. ZIndex ZIndex is the sorting index for the sprite, the higher the number the later that it is rendered (meaning the more on top it is). Its also used for collision detection, sprites on different ZIndexes do not get collision tested against one another. OnCollide This property sets up the sprites collision handler event. Set this property to a function name to have that function called when the sprite collides with another sprite. TAnimatedSprite TAnimatedSprite surfaces a sprite with built in animation handeling. Take a look through the demos for a better idea of how to use this class. Draw(FrameTime) Reset() SetBoundsRect(Left, Top, Right, Bottom) Image PatternIndex X Y ZIndex OnCollide AnimSpeed AnimStart AnimEnd AnimIndex AnimReverse OnAnimEnd TTiledBackground TTiledBackground surfaces the standard rectuangular tiled map class. Take a look at the SimpleSpriteDemo for a sample of how to use this component, you may also look at Tank Brigade for more information. Draw(FrameTime) SetSize(TilesWide, TilesHigh) TileImage( X, Y ) Image PatternIndex X Y ZIndex OnCollide TileWidth TileHeight TilesWide TilesHigh Width Height TTileImage TTileImage is a sub component of TTiledBackground, use it only as a reference, as creating one may cause the system to fail. PatternIndex Image TSound TSound is the base class for non-background music sounds. Use it to load WAV and OGG files for replaying at a later time. LoadFromFile(FileName) Play() PlayNewChannel(NewChannelNumber) Stop() Name Volume Channel Playing TSoundEngine The sound engine is used to manage all sound objects, you should seldom need to actually work with the sound engine. AddSoundFile(FileName) AddSound(ExistingSound) Delete(ItemIndex) Remove(ExistingSound) Next() Previous() First() Last() Reset() Play() Stop() Sound(Index) Count Playing IsPlaying Channel TTTFFont TTTFFont Surfaces a way to interact with standard Windows True Type Fonts within the game engine. It should be noted that the ttf file you are trying to load must be placed in your games path. ImageFonts tend to have a better render quality then true type fonts. new(FontFile, FontSize) TextOut(X, Y, WhatText) FontColor Height TImageFont TImageFont surfaces a way to interact with "Bitmap" fonts, these are image that contain all characters that the font represents. Take a look at just about any demo to see an example of this being used. ImageFonts tend to have a better render quality then true type fonts. TextOut(X, Y, WhatText) CharPattern(Character) SetCharPattern(Char, Pattern) CharWidth(Char) CharHeight(Char) Image TGUIElement TGUIElement is the base class for all extendable GUI elements. See the GUI demo application to learn more. BeforeDraw() Draw() AfterDraw() OnMouseDown(MouseX, MouseY, LeftDown, RightDown, MiddleDown) OnMouseUp(MouseX, MouseY, LeftDown, RightDown, MiddleDown) OnClick(MouseX, MouseY, LeftDown, RightDown, MiddleDown) OnMouseWheel(MouseX, MouseY, WheelDelta) OnKeyDown(KeyCode, ShiftState, Unicode) OnKeyUp(KeyCode, ShiftState, Unicode) X Y Width Height Enabled Visible Focused SDL_putenv(EnvStatement) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_getenv(EnvVarName) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_PutPixel(DstSurface, x, y, pixel) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_AddPixel(DstSurface, x, y, pixel) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_SubPixel(DstSurface, x, y, pixel) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_DrawLine(DstSurface, x, y, x2, y2, Color[, DashLength, DashSpace]) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_AddLine(DstSurface, x1, y1, x2, y2, Color) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_SubLine(DstSurface, x1, y1, x2, y2, Color) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_AddSurface(SrcSurface, SrcRect, DestSurface, DestRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_SubSurface(SrcSurface, SrcRect, DestSurface, DestRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_MonoSurface(SrcSurface, SrcRect, DestSurface, DestRect, Color) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_TexturedSurface(SrcSurface, SrcRect, DestSurface, DestRect, Texture, TextureRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_ZoomSurface(SrcSurface, SrcRect, DstSurface, DstRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_FlipRectH(DstSurface, Rect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_FlipRectV(DstSurface, Rect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_ScrollY(DstSurface, DifY) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_ScrollX(DstSurface, DifX) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_RotateDeg(DstSurface, SrcSurface, SrcRect, DestX, DestY, OffsetX, OffsetY, Angle) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_RotateRad(DstSurface, SrcSurface, SrcRect, DestX, DestY, OffsetX, OffsetY, Angle) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_FillRectAdd(DstSurface, dstrect, color) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_FillRectSub(DstSurface, dstrect, color) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_GradientFillRect(DstSurface, Rect, StartColor, EndColor, Style) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_2xBlit(Src, Dest) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_Scanline2xBlit(Src, Dest) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_50Scanline2xBlit(Src, Dest) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_ORSurface(SrcSurface, SrcRect, DestSurface, DestRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_ANDSurface(SrcSurface, SrcRect, DestSurface, DestRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_GTSurface(SrcSurface, SrcRect, DestSurface, DestRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_LTSurface(SrcSurface, SrcRect, DestSurface, DestRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_PixelTest(SrcSurface1, SrcRect1, SrcSurface2, SrcRect2, Left1, Top1, Left2, Top2) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_GetPixel(SrcSurface, x, y) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. PSDLRect(aLeft, aTop, aWidth, aHeight) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDLRect(aLeft, aTop, aWidth, aHeight) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_ScaleSurfaceRect(SrcSurface, SrcX1, SrcY1, SrcW, SrcH, Width, Height) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. ValidateSurfaceRect(DstSurface, dstrect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_PixelTestSurfaceVsRect(SrcSurface1, SrcRect1, SrcRect2, Left1, Top1, Left2, Top2) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SDL_ClipLine(x1, y1, x2, y2, ClipRect) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. GetMouseState():X, Y, State This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. IsBitSet(Source, BitMask):Boolean Use IsBitSet to tell if a bitmask is set within a source number. JoystickUpdate() This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickClose(Joystick) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. NumJoysticks() This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickName(Index) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickOpen(Index) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickOpened(Index) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickIndex(Joystick) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickNumAxes(Joystick) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickNumBalls(Joystick) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickNumHats(Joystick) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickNumButtons(Joystick) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickEventState(state) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickGetAxis(joystick, axis) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickGetHat(joystick, hat) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickGetBall(joystick, ball, dx, dy) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. JoystickGetButton(joystick, Button) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. SetCaption(NewCaption) Sets the caption of the current game window. IsKeyDown(KeyCode):Boolean Tests to see if a key is down (See KEY_ in the global/values). LogError(ErrorMessage[, Location]) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. LogWarning(WarningMessage[, Location]) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. LogStatus(StatusMessage[, Location]) This method is a wrapper around the standard SDL library method. See the standard SDL documentation around this method and its usage. Close() Closes the currently running game instance. CreateThreadedProcess(ThreadTable, ThreadMethod[, ThreadName]) This method is extremely unstable and should not be used. SetVideoMode(Width, Height, BitsPerPixel, [FullScreen = false]) Use SetVideoMode to setup the render window options. HexToInt(HexString) Use HexToInt to take a hex string and convert it to a number. GetTickCount() Returns the current system time in milliseconds, good for timing across all platforms. RenderGUI() Call this method to have all enabled TGUIElement's rendered to the game screen. Handler(AnEventName[, NewHandler]):AnEventHandler Handler is a dual purpose method. You can use it to set an event handler (Handler('OnClick', 'MyClickHandler')) or get back the current event handler (WhatHandler = Handler('OnClick')). char(CharacterCode, ...):Character, ... Converts a character code (numeric) or series of character codes to their corrisponding characters (ASCII). ord(Character, ...):CharacterCode, ... Converts a character (ASCII) or series of characters to their respective character codes (numerical). SoundAvailable Used to tell if SDL could initialize a sound engine when it started up. KEY_UNKNOWN KEY_FIRST KEY_BACKSPACE KEY_TAB KEY_CLEAR KEY_RETURN KEY_ENTER KEY_PAUSE KEY_ESCAPE KEY_SPACE KEY_EXCLAIM KEY_QUOTEDBL KEY_HASH KEY_DOLLAR KEY_AMPERSAND KEY_QUOTE KEY_LEFTPAREN KEY_RIGHTPAREN KEY_ASTERISK KEY_PLUS KEY_COMMA KEY_MINUS KEY_PERIOD KEY_SLASH KEY_0 KEY_1 KEY_2 KEY_3 KEY_4 KEY_5 KEY_6 KEY_7 KEY_8 KEY_9 KEY_COLON KEY_SEMICOLON KEY_LESS KEY_EQUALS KEY_GREATER KEY_QUESTION KEY_AT KEY_LEFTBRACKET KEY_BACKSLASH KEY_RIGHTBRACKET KEY_CARET KEY_UNDERSCORE KEY_BACKQUOTE KEY_a KEY_b KEY_c KEY_d KEY_e KEY_f KEY_g KEY_h KEY_i KEY_j KEY_k KEY_l KEY_m KEY_n KEY_o KEY_p KEY_q KEY_r KEY_s KEY_t KEY_u KEY_v KEY_w KEY_x KEY_y KEY_z KEY_DELETE KEY_WORLD_0 KEY_WORLD_1 KEY_WORLD_2 KEY_WORLD_3 KEY_WORLD_4 KEY_WORLD_5 KEY_WORLD_6 KEY_WORLD_7 KEY_WORLD_8 KEY_WORLD_9 KEY_WORLD_10 KEY_WORLD_11 KEY_WORLD_12 KEY_WORLD_13 KEY_WORLD_14 KEY_WORLD_15 KEY_WORLD_16 KEY_WORLD_17 KEY_WORLD_18 KEY_WORLD_19 KEY_WORLD_20 KEY_WORLD_21 KEY_WORLD_22 KEY_WORLD_23 KEY_WORLD_24 KEY_WORLD_25 KEY_WORLD_26 KEY_WORLD_27 KEY_WORLD_28 KEY_WORLD_29 KEY_WORLD_30 KEY_WORLD_31 KEY_WORLD_32 KEY_WORLD_33 KEY_WORLD_34 KEY_WORLD_35 KEY_WORLD_36 KEY_WORLD_37 KEY_WORLD_38 KEY_WORLD_39 KEY_WORLD_40 KEY_WORLD_41 KEY_WORLD_42 KEY_WORLD_43 KEY_WORLD_44 KEY_WORLD_45 KEY_WORLD_46 KEY_WORLD_47 KEY_WORLD_48 KEY_WORLD_49 KEY_WORLD_50 KEY_WORLD_51 KEY_WORLD_52 KEY_WORLD_53 KEY_WORLD_54 KEY_WORLD_55 KEY_WORLD_56 KEY_WORLD_57 KEY_WORLD_58 KEY_WORLD_59 KEY_WORLD_60 KEY_WORLD_61 KEY_WORLD_62 KEY_WORLD_63 KEY_WORLD_64 KEY_WORLD_65 KEY_WORLD_66 KEY_WORLD_67 KEY_WORLD_68 KEY_WORLD_69 KEY_WORLD_70 KEY_WORLD_71 KEY_WORLD_72 KEY_WORLD_73 KEY_WORLD_74 KEY_WORLD_75 KEY_WORLD_76 KEY_WORLD_77 KEY_WORLD_78 KEY_WORLD_79 KEY_WORLD_80 KEY_WORLD_81 KEY_WORLD_82 KEY_WORLD_83 KEY_WORLD_84 KEY_WORLD_85 KEY_WORLD_86 KEY_WORLD_87 KEY_WORLD_88 KEY_WORLD_89 KEY_WORLD_90 KEY_WORLD_91 KEY_WORLD_92 KEY_WORLD_93 KEY_WORLD_94 KEY_WORLD_95 KEY_KP0 KEY_KP1 KEY_KP2 KEY_KP3 KEY_KP4 KEY_KP5 KEY_KP6 KEY_KP7 KEY_KP8 KEY_KP9 KEY_KP_PERIOD KEY_KP_DIVIDE KEY_KP_MULTIPLY KEY_KP_MINUS KEY_KP_PLUS KEY_KP_ENTER KEY_KP_EQUALS KEY_UP KEY_DOWN KEY_RIGHT KEY_LEFT KEY_INSERT KEY_HOME KEY_END KEY_PAGEUP KEY_PAGEDOWN KEY_F1 KEY_F2 KEY_F3 KEY_F4 KEY_F5 KEY_F6 KEY_F7 KEY_F8 KEY_F9 KEY_F10 KEY_F11 KEY_F12 KEY_F13 KEY_F14 KEY_F15 KEY_NUMLOCK KEY_CAPSLOCK KEY_SCROLLOCK KEY_RSHIFT KEY_LSHIFT KEY_RCTRL KEY_LCTRL KEY_RALT KEY_LALT KEY_RMETA KEY_LMETA KEY_LSUPER KEY_RSUPER KEY_MODE KEY_COMPOSE KEY_HELP KEY_PRINT KEY_SYSREQ KEY_BREAK KEY_MENU KEY_POWER KEY_EURO BUTTON_LEFT BUTTON_MIDDLE BUTTON_RIGHT BUTTON_WHEELUP BUTTON_WHEELDOWN BUTTON_LMASK BUTTON_MMASK BUTTON_RMask MAX_JOYSTICKS MAX_AXES MAX_BUTTONS AXIS_MIN AXIS_MAX JOY_AXIS_THRESHOLD HAT_CENTERED HAT_UP HAT_RIGHT HAT_DOWN HAT_LEFT HAT_RIGHTUP HAT_RIGHTDOWN HAT_LEFTUP HAT_LEFTDOWN JOYAXISMOTION JOYBALLMOTION JOYHATMOTION JOYBUTTONDOWN JOYBUTTONUP