INFO
These commands can be used to remove individual objects, layers or complete HUDs.

Note: when using ClearWorld, you must call HUD_RemoveAll before!

Example: 

HUD_RemoveAll ; DELETE ANY HUD OBJECTS FIRST
ClearWorld()  ; THEN CALL CLEARWORLD

CLEAN-UP COMMANDS
Note: all Sprite Candy commands have the prefix "HUD" at the beginning, regardless if they're related to HUDs, layers or objects.

  HUD_RemoveObject
  HUD_ClearLayer
  HUD_ClearLayers
  HUD_RemoveLayer
  HUD_RemoveLayers
  HUD_Remove
  HUD_RemoveAll
  HUD_FreeFonts
  HUD_FreeImageResources



HUD_RemoveObject

HUD_RemoveObject (  Object_Handle%  )

Use this command to delete an object at any time. This command will automatically delete any animations or effects that have been attached to this object.

Object_Handle%
Handle of an object (text, image, shape etc.) to delete.

JUMP TO TOP OF PAGE


HUD_ClearLayer

HUD_ClearLayer (  Layer_Handle%  )

This command clears a layer by deleting all objects placed on it without deleting the layer itself.

Layer_Handle%
Handle of a layer created with HUD_CreateLayer( ).

JUMP TO TOP OF PAGE


HUD_ClearLayers

HUD_ClearLayers (  [HUD_Handle%]  )

Use this command to clear all layers of a specified HUD (or all HUDs) at once. All existing objects (texts, images, shapes etc.) will be removed. The layers themselves will not be removed.

HUD_Handle%
Handle of a HUD - if not specified, ALL layers of all HUDs will be cleared.

JUMP TO TOP OF PAGE


HUD_RemoveLayer

HUD_RemoveLayer (  Layer_Handle%  )

This command removes (deletes) a layer and all objects on it permanently.

Layer_Handle%
Handle of a layer created with HUD_CreateLayer( ).

JUMP TO TOP OF PAGE


HUD_RemoveLayers

HUD_RemoveLayers (  [HUD_Handle%]  )

Use this command to remove (delete) all existing layers and all objects of a certain HUD or all HUDs at once. All layers will be removed, so only the empty HUDs will remain.

HUD_Handle%
Handle of a HUD created with HUD_Create( ). If '0' or not specified, ALL existing HUDs will be affected.

JUMP TO TOP OF PAGE


HUD_Remove

HUD_Remove (  HUD_Handle%  )

This will remove (delete) a complete HUD, including all objects, all layers on it and the HUD itself.

HUD_Handle%
Handle of a HUD created with HUD_Create( ).

JUMP TO TOP OF PAGE


HUD_RemoveAll

HUD_RemoveAll (  freeTextures%  )

This command clears everything: all objects, all layers, all HUDs and , when specified, all textures and fonts loaded.

Note: when using ClearWorld, you must call HUD_RemoveAll, too. Use it right before ClearWorld then!

freeTextures%

  • TRUE - All loaded fonts and textures will be cleared.
  • FALSE - Only HUDs, layers and objects will be removed. Textures and fonts can still be used without reloading.

    JUMP TO TOP OF PAGE


    • HUD_FreeFonts

    HUD_FreeFonts (  [FontHandle%]  )

    Unloads a specified font or ALL fonts, if no handle has been specified.

    FontHandle%
    Handle of a font load with HUD_LoadFont( ). If not specified, ALL existing fonts will be deleted.

    JUMP TO TOP OF PAGE


    HUD_FreeImageResources

    HUD_FreeImageResources (  [ResourceHandle%]  )

    Unloads a specified image resource (texture) or ALL textures loaded, if no handle has been specified.

    ResourceHandle%
    Handle of an image resource (texture) as loaded with HUD_LoadImageResource( ). If not specified, ALL existing textures will be deleted.

    JUMP TO TOP OF PAGE


    ©2004,2005 Mike Dogan / X-PRESSIVE.COM
    X-PRESSIVE.COM is a label and working title of Mike Dogan, est. 1999
    All artwork, including graphics, text, images and sounds are property of Mike Dogan, X-PRESSIVE.COM. Trademarks belong to their respective owners. All rights reserved.