• Home
• RAGENativeUI
• UIMenu

C# Class RAGENativeUI.UIMenu

显示文件 Open project: alexguirre/RAGENativeUI Class Usage Examples

Public Properties

Property	Type	Description
AUDIO_BACK	string
AUDIO_ERROR	string
AUDIO_LEFTRIGHT	string
AUDIO_LIBRARY	string
AUDIO_SELECT	string
AUDIO_UPDOWN	string
AllowCameraMovement	bool
ControlDisablingEnabled	bool
FormatDescriptions	bool
HoldTimeBeforeScroll	uint
MenuItems	List
MouseControlsEnabled	bool
MouseEdgeEnabled	bool
ResetCursorOnOpen	bool

Public Methods

Method	Description
AddInstructionalButton ( InstructionalButton button ) : void
AddItem ( UIMenuItem item ) : void	Add an item to the menu.
BindMenuToItem ( UIMenu menuToBind, UIMenuItem itemToBindTo ) : void	Bind a menu to a button. When the button is clicked that menu will open.
Clear ( ) : void	Remove all items from the menu.
DisEnableControls ( bool enable ) : void	Enable or disable all controls but the necessary to operate a menu.
DisableInstructionalButtons ( bool disable ) : void	Enable or disable the instructional buttons.
Draw ( ) : void	Draw the menu and all of it's components.
DrawBanner ( Rage g ) : void	Draw your custom banner. To prevent flickering call it inside a Game.RawFrameRender event handler.
GetSafezoneBounds ( ) : Point	Returns the safezone bounds in pixel, relative to the 1080pixel based system.
GetScreenResolutionMantainRatio ( ) : SizeF	Returns the 1080pixels-based screen resolution while mantaining current aspect ratio.
GoBack ( ) : void	Close or go back in a menu chain.
GoDown ( ) : void	Go up the menu if the number of items is less than or equal to the maximum items on screen.
GoDownOverflow ( ) : void	Go down the menu if the number of items is more than maximum items on screen.
GoLeft ( ) : void	Go left on a MenuListItem.
GoRight ( ) : void	Go right on a MenuListItem.
GoUp ( ) : void	Go up the menu if the number of items is less than or equal to the maximum items on screen.
GoUpOverflow ( ) : void	Go up the menu if the number of items is more than maximum items on screen.
HasControlJustBeenPressed ( Common control, Keys key = Keys.None ) : bool	Check whether a menucontrol has been pressed.
HasControlJustBeenReleaseed ( Common control, Keys key = Keys.None ) : bool	Check whether a menucontrol has been released.
IsControlBeingPressed ( Common control, Keys key = Keys.None ) : bool	Checks whether a menucontrol is being pressed and if selected item is UIListItem, uses UIListItem variables
IsMouseInBounds ( Point topLeft, Size boxSize ) : bool	Chech whether the mouse is inside the specified rectangle.
IsMouseInListItemArrows ( UIMenuListItem item, Point topLeft, Point safezone ) : int	Function to get whether the cursor is in an arrow space, or in label of an MenuListItem.
ProcessControl ( Keys key = Keys.None ) : void	Process control-stroke. Call this in the Game.FrameRender event or in a loop.
ProcessKey ( Keys key ) : void	Process keystroke. Call this in the Game.FrameRender event or in a loop.
ProcessMouse ( ) : void	Process the mouse's position and check if it's hovering over any Element. Call this in Game.FrameRender or in a loop.
RefreshIndex ( ) : void	Reset the current selected item to 0. Use this after you add or remove items dynamically.
ReleaseMenuFromItem ( UIMenuItem releaseFrom ) : bool	Remove menu binding from button.
RemoveInstructionalButton ( InstructionalButton button ) : void
RemoveItemAt ( int index ) : void	Remove an item at index n.
Reset ( bool resetLists, bool resetCheckboxes ) : void	Sets the index of all lists to 0 and unchecks all the checkboxes.
ResetKey ( Common control ) : void	Remove all controls on a control.
SelectItem ( ) : void	Activate the current selected item.
SetBannerType ( RAGENativeUI.Elements.ResRectangle rectangle ) : void	Set the banner to your own Rectangle.
SetBannerType ( Sprite spriteBanner ) : void	Set the banner to your own Sprite object.
SetBannerType ( Texture texture ) : void	Set the banner to your own custom texture. Set it to null if you want to restore the banner.
SetKey ( Common control, GameControl gtaControl ) : void	Set a Rage.GameControl to control a menu. Can be multiple controls. This applies it to all indexes.
SetKey ( Common control, GameControl gtaControl, int controlIndex ) : void	Set a Rage.GameControl to control a menu only on a specific index.
SetKey ( Common control, Keys keyToSet ) : void	Set a key to control a menu. Can be multiple keys for each control.
SetMenuWidthOffset ( int widthOffset ) : void	Change the menu's width. The width is calculated as DefaultWidth + WidthOffset, so a width offset of 10 would enlarge the menu by 10 pixels.
UIMenu ( string title, string subtitle ) : System	Basic Menu constructor.
UIMenu ( string title, string subtitle, Point offset ) : System	Basic Menu constructor with an offset.
UIMenu ( string title, string subtitle, Point offset, Texture customBanner ) : System	Initialise a menu with a custom texture banner.
UIMenu ( string title, string subtitle, Point offset, string spriteLibrary, string spriteName ) : System	Advanced Menu constructor that allows custom title banner.
UpdateScaleform ( ) : void	Manually update the instructional buttons scaleform.

Protected Methods

Method	Description
CheckboxChange ( RAGENativeUI.Elements.UIMenuCheckboxItem sender, bool Checked ) : void
IndexChange ( int newindex ) : void
ItemSelect ( UIMenuItem selecteditem, int index ) : void
ListChange ( UIMenuListItem sender, int newindex ) : void
MenuChangeEv ( UIMenu newmenu, bool forward ) : void
MenuCloseEv ( ) : void

Private Methods

Method	Description
DrawBanner ( GraphicsEventArgs e ) : void
EnableCameraMovement ( ) : void
FormatDescription ( string input ) : string	Formats the input string so it doesn't go out of bounds of the description box.
RecaulculateDescriptionPosition ( ) : void

Method Details

Property Details