INFO
These commands can be used to group text or image objects. Grouping objects simplifies the usage of many objects at once. Grouped objects can be moved, colorized, turned etc. together using a single command only.

For example: if you created fifty images, you would have to loop through all the images each time you want to apply an effect to them or change their color. By assigning them all to a group, you'll be able to affect them all at once using a single command only.

Group handles can be passed to most of the object commands (see section "Object Commands") instead of the "ObjectHandle" parameter. Group handles can also be used with ALL the FX-commands.

You can even assign an object to several different groups at once. You can also remove an object from a group at any time. If you delete an object, Sprite Candy will ungroup it automatically, if required. So you don't have to care about ungrouping objects before removing them.

You can also assign objects on different layers to the same group.

Note: Objects within a group will not be rotated around a shared origin, for example. Using groups is just a time-saving feature similar to batch-processing. Sprite Candy will loop through all objects assigned to a group and apply the regarding command to one object after another.

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

  HUD_CreateGroup
  HUD_RemoveGroup
  HUD_DeleteGroup
  HUD_AddToGroup
  HUD_RemoveFromGroup



HUD_CreateGroup

GroupHandle% HUD_CreateGroup   )

This will create an empty group and return a handle to this group.

JUMP TO TOP OF PAGE


HUD_RemoveGroup

HUD_RemoveGroup GroupHandle%  )

This command ungroups all objects assigned to the specified group and deletes the empty group item. Only the group item will be deleted, the objects remain ungrouped.

GroupHandle%
Handle of a group created with HUD_CreateGroup( ).

JUMP TO TOP OF PAGE


HUD_DeleteGroup

HUD_DeleteGroup GroupHandle%  )

This command deletes the group item AND all assigned objects. You can use this command to mass-delete all objects assigned to a certain group.

GroupHandle%
Handle of a group created with HUD_CreateGroup( ).

JUMP TO TOP OF PAGE


HUD_AddToGroup

HUD_AddToGroup ObjectHandle% ,  GroupHandle%  )

This command assigns a specified object (text, image, shape etc.) to a certain group. The object itself will not be altered in any way, but you will now be able to access multiple objects at once after you assigned them to a group. You can create an unlimited amount of groups and you can also assign an object to as many different groups as you like to.

ObjectHandle%
Handle of an object (text, image, shape, etc.)

GroupHandle%
Handle of a group created with HUD_CreateGroup( ).

JUMP TO TOP OF PAGE


HUD_RemoveFromGroup

HUD_RemoveFromGroup ObjectHandle% ,  GroupHandle%  )

This command un-assigns a specified object (text, image, shape etc.) from a certain group again.

ObjectHandle%
Handle of an object (text, image, shape, etc.)

GroupHandle%
Handle of a group created with HUD_CreateGroup( ).

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.