Scaleform Studio Lua API Reference: scaleform.SpriteSheet table reference
scaleform.SpriteSheet table reference
scaleform.SpriteComponent.load_sprite_sheet (self, sprite_sheet) : integerCreates and loads the sprites based on the sprite sheet description.
scaleform.SpriteSheet.frames : scaleform.SpriteFrame[]A list of frames.
scaleform.SpriteFrame{ anchor : integer[], bounds : scaleform.Rect, }
scaleform.SpriteSheet.ImgFilePath : stringThe image file path. A string of characters.
scaleform.SpriteSheet.num_frames : integerThe number of frames to display. A strictly integral numeric value, with no decimal component.
self : scaleform.SpriteComponentThe sprite to load the sheet for.
sprite_sheet : scaleform.SpriteSheetThe spritesheet to load.
integerThe index of the spritesheet loaded from 1 to number of spritesheets.
scaleform.RectA rectangle based upon two points.
{ x1 : number, x2 : number, y1 : number, y2 : number, }
scaleform.SpriteComponentRepresents a sprite object.
scaleform.SpriteSheet{ frames : scaleform.SpriteFrame[], ImgFilePath : string, num_frames : integer, }A numeric value.Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.