List Window Object

List Window

Properties

Name	Category	Type	Description	ReadOnly
PERCENT X	POSITION	float	X Position as a percent.
PERCENT Y	POSITION	float	Y Position as a percent.
OFFSET X	POSITION	float	X offset in pixels.
OFFSET Y	POSITION	float	Y offset in pixels
WIDTH	SIZE	float	Width in actual pixels.
HEIGHT	SIZE	float	Height in actual pixels.
SCALE WIDTH	SIZE	float	Width in actual pixels.
SCALE HEIGHT	SIZE	float	Height in actual pixels.
TOOL TIP	ADVANCED	string	The tool tip of this window.
TOOL TIP VISUAL	ADVANCED	string	The visual tooltip file.
TOOL TIP INHERITED	ADVANCED	bool	Does the tooltip inherit from parent?
CLIPPED	ADVANCED	bool	If true it's clipped by the parent.
MOUSE PASS THROUGH	ADVANCED	bool	If false the mouse will give the object events.
LIST INDEX	ADVANCED	int	Used for sorting items in lists and reflow windows
ALWAYS ON TOP	ADVANCED	bool	If true the widget will always be on top.
ALPHA	ADVANCED	float	The alpha of the window.
PUSH BACK	ADVANCED	bool	If true when the widget loads it gets pushed back.
ADD PROPS	ADVANCED	string	Additional properties. PropName=Value
SORT OFFSET	ADVANCED	int	Offset to the window's sort order
VISIBLE	VISIBILITY AND ENABLED	bool	Is it visible.
ENABLED	VISIBILITY AND ENABLED	bool	Is it enabled.
VERTICLE	FRAME ALIGNMENT	string	Vertical alignment of the frame.
HORIZONTAL	FRAME ALIGNMENT	string	Horizontal alignment of frame.
WIDGET NAME	DATA	string	The name used in code for ref.
STRING DATA	DATA	string	Data used by code.
INTEGER DATA	DATA	int	Integer Data used by code.
RENDER WINDOW	ADVANCED	bool	If true render window will try to sort itself with other render windows. Usually you only have a single render window per menu.
SORT	ARRANGMENT TYPE	string	How it should sort.
SCALE TO FIT	ARRANGMENT TYPE	bool	Scales the window to fit the contents.
PADDING	PADDING	CVector2	Padding to place on right and bottom
USE MAX SIZE	ARRANGMENT TYPE	bool	Will use max size instead of the visual size on screen. Good to use with scale to fit.
PAGE SIZE	PAGING	int	Number of elements per page. (not paging if size size <= 0)
PAGE INDEX	PAGING	int	Starting page index when using list paging (not paging if size size <= 0)
PAGE LOOP	PAGING	bool	If true, pages will loop around when incremented/decremented
PAGE STATUS WIDGET	PAGING	string	If set, the paging status will be displayed in the text of this widget
MIN PERCENT WIDTH	MIN AND MAX SIZE	float	Min percent width.
MIN PERCENT HEIGHT	MIN AND MAX SIZE	float	Min percent height.
MIN PIXEL WIDTH	MIN AND MAX SIZE	float	Min pixel width.
MIN PIXEL HEIGHT	MIN AND MAX SIZE	float	Min pixel height.
MAX PERCENT WIDTH	MIN AND MAX SIZE	float	Max percent width.
MAX PERCENT HEIGHT	MIN AND MAX SIZE	float	Max percent height.
MAX PIXEL WIDTH	MIN AND MAX SIZE	float	Max pixel width.
MAX PIXEL HEIGHT	MIN AND MAX SIZE	float	Max pixel height.
ALLOWED UNITTYPES	FILTERS	int	Unittypes allowed.
NOT ALLOWED UNITTYPES	FILTERS	int	Unittypes not allowed.
SYSTEM	GAME SYSTEM	string	Will list what is in the specific game system.
CONTAINER	GAME SYSTEM	string	The container to show contents of
FILE	LAYOUT OVERRIDE	string	The layout file that should override the default housing of the items listed.
SELECT FIRST	PROPERTIES	bool	If true it will find the first item in the list and select it. WOrks for buttons and toggle buttons.
TYPE	TARGETING	string	The type of target the list should use.
INDEX	TARGETING	int	The index of the target type.
SECONDARY INDEX	TARGETING	int	The secondar index of the target type.
TARGET NAME	TARGETING	string	The name of the unit in the level.

Input Events

Show

Hide

Toggle Visibility

Disable

Enable

Reflow

Next Page

Previous Page

Randomize Page Index

Output Events

On Visible

On Invisible

Mouse Entered

Mouse Leave

HAS CONTENTS

IS EMPTY

Items Size > Page Size

Items Size <= Page Size

At last page

At first page

At a middle page