Rococo GreatSex Game Options Widget 1.0 Specification

Game Options Widget

This is part of the Rococo GreatSex specification. Click here to return to the main documentation. The directive GameOptions as a subdirective of any widget creates a game options meta widget - a set of suboptions that are generated procedurally by reflection. As with all widget directives it accepts any of the Panel attributes and any of the Colour attributes. The Panel and Colour tables are at the end of the GreatSex documentation. The Generate attribute acts a string key, tying the GameOptions widget to a GameOptions interface supplied to the GreatSex widget tree generator. If no such interface matches, the game option widget is populated by an error description that will list known option names and also point the developer to the C++ source line in which the error is raised.

		/* Example: 
		(GameOptions 
			(Panel.Description GameOptions.Gameplay)
			(Title.Style TitlesOnLeft)
			(Title.Alignment Left)
			(Title.Font SubOptionTitleFont)
			(SubscribeToCommitButtons) 
			
			// Multiplies the title font height to yield the title control height. (For TitleOnLeft this will define the row height)
			(Title.HeightMultiplier 1.75)
			
			// Multiplies the title font height to yield the title x spacing.
			(Title.XSpacingMultiplier 0.25)
			
			// Gives the padding of the carousel controls to their interior rectangle
			(#Recti Carousel.Padding 40 2 40 4)
			
			// Gives the padding of the carousel drop-down controls to their interior rectangle
			(#Recti Carousel.Button.Padding 4 4 4 4)
			
			// Determine which side of the control the numeric feedback is rendered at
			(Scalar.Guage.Alignment Centre)
			
			// Offset from alignment edge to guage
			(#Vec2i Scalar.Guage.Spacing 12 4)
			
			// Gives the padding of the slider control slot to the slider control edges
			(#Recti Scalar.Slot.Padding 40 4 40 4)
			
			// Gives the padding of the string control slot to the string control edges
			(#Recti String.Slot.Padding 40 4 40 4)
			
			
			(Carousel.Font CarouselFont)
			(Carousel.Button.Font CarouselFont)
			(Slider.Font SliderFont)
		
			// The Generate attribute determines which options are used to generate the children
			(Generate GameplayOptions)
		)
		

Attributes

• Title.Style TitlesOnLeft

  - Display suboption titles on the left side of the corresponding control widgets, rather than over head. With the first release version of 1.2 of GreatSex, this is the most tested scenario.

• Title.Alignment [alignment]

  - Set the title text alignment. Must be one of Left|Right|Top|Bottom|TopLeft|TopRight|BottomLeft|BottomRight|Centre.

• Title.Font [fontId]

  - Set the title text font id. Must match the id of a Font top-level directive.

• SubscribeToCommitButtons

  - An existential attribute that when present links any commit buttons in the GUI to the commit method of the game option widget's underlying C++ interface. It allows one to distinguish between potential/pending changes and committed/accepted changes. It is up to the C++ implementor to ensure the distinction is implemented.

• Title.HeightMultiplier [scale]

  - Multiplies the Title.Font height by the scale factor to create the title control height. Valid range is 1.0 to 10.0

• Title.XSpacingMultiplier [scale]

  - Multiplies the title font height to yield the title x spacing of the title text. The effect of the spacing depends on the Title.Alignment. Valid range is 0.0 to 10.0.

• #Recti Carousel.Padding [Left] [Top] [Right] [Bottom]

  - Pads carousel controls. Carousels in an options widget loop through choice options and can expand to a drop-down list.

• #Recti Carousel.ButtonPadding [Left] [Top] [Right] [Bottom]

  - Pads carousel drop-down buttons.

• Scalar.Guage.Alignment [alignment]

  - Sets the position of the guage in a scalar slider control. Must be one of Left|Right|Top|Bottom|TopLeft|TopRight|BottomLeft|BottomRight|Centre.

• #Vec2i Scalar.Guage.Spacing [X] [Y]

  - Sets the guage text spacing. The effect of the spacing depends on Guage.Alignment.

• #Recti Scalar.Slot.Padding [Left] [Top] [Right] [Bottom]

  - Sets the slider slot padding that positions and scales the slider slot within the slider widget.

• #Recti String.Slot.Padding [Left] [Top] [Right] [Bottom]

  - Sets the string slot padding that positions and scales the string slot within the string editor widget.

• Carousel.Font [id]

  - Sets the font id of the carousel font. The id must match that of a Font top-level directive.

• Carousel.Button.Font [id]

  - Sets the font id of the carousel's drop down buttons. The id must match that of a Font top-level directive.

• Slider.Font [id]

  - Sets the font id of the slider value font. The id must match that of a Font top-level directive.

• Generate [id]

  - Selects the C++ option interface that links to the widget. The first paragraph of this documentation has more information.