{ "UI": { "id": 7, "documentation": "\n\nProvides functionality for drawing and interacting with in-game user interface elements.\n\n\nFor drawing 3D objects in the flight scene, see the Drawing service.\n\n", "procedures": { "AddCanvas": { "id": 1, "parameters": [], "return_type": { "code": "CLASS", "service": "UI", "name": "Canvas" }, "return_is_nullable": false, "documentation": "\n\nAdd a new canvas.\n\n\nIf you want to add UI elements to KSPs stock UI canvas, use .\n\n" }, "Message": { "id": 2, "parameters": [ { "name": "content", "type": { "code": "STRING" } }, { "name": "duration", "type": { "code": "FLOAT" }, "default_value": "AACAPw==" }, { "name": "position", "type": { "code": "ENUMERATION", "service": "UI", "name": "MessagePosition" }, "default_value": "Ag==" }, { "name": "color", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "default_value": "CggAAAAAAADwPwoIcT0K16Nw7T8KCPyp8dJNYpA/" }, { "name": "size", "type": { "code": "FLOAT" }, "default_value": "AACgQQ==" } ], "documentation": "\n\nDisplay a message on the screen.\n\n\nThe message appears just like a stock message, for example quicksave or quickload messages.\n\nMessage content.\nDuration before the message disappears, in seconds.\nPosition to display the message.\nSize of the message, differs per position.\nThe color of the message.\n" }, "Clear": { "id": 3, "parameters": [ { "name": "clientOnly", "type": { "code": "BOOL" }, "default_value": "AA==" } ], "documentation": "\n\nRemove all user interface elements.\n\nIf true, only remove objects created by the calling client.\n" }, "get_StockCanvas": { "id": 4, "parameters": [], "return_type": { "code": "CLASS", "service": "UI", "name": "Canvas" }, "return_is_nullable": false, "documentation": "\n\nThe stock UI canvas.\n\n" }, "Button_Remove": { "id": 5, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Button" } } ], "documentation": "\n\nRemove the UI object.\n\n" }, "Button_get_RectTransform": { "id": 6, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Button" } } ], "return_type": { "code": "CLASS", "service": "UI", "name": "RectTransform" }, "return_is_nullable": false, "documentation": "\n\nThe rect transform for the text.\n\n" }, "Button_get_Text": { "id": 7, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Button" } } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Text" }, "return_is_nullable": false, "documentation": "\n\nThe text for the button.\n\n" }, "Button_get_Clicked": { "id": 8, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Button" } } ], "return_type": { "code": "BOOL" }, "return_is_nullable": false, "documentation": "\n\nWhether the button has been clicked.\n\n\nThis property is set to true when the user clicks the button.\nA client script should reset the property to false in order to detect subsequent button presses.\n\n" }, "Button_set_Clicked": { "id": 9, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Button" } }, { "name": "value", "type": { "code": "BOOL" } } ], "documentation": "\n\nWhether the button has been clicked.\n\n\nThis property is set to true when the user clicks the button.\nA client script should reset the property to false in order to detect subsequent button presses.\n\n" }, "Button_get_Visible": { "id": 10, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Button" } } ], "return_type": { "code": "BOOL" }, "return_is_nullable": false, "documentation": "\n\nWhether the UI object is visible.\n\n" }, "Button_set_Visible": { "id": 11, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Button" } }, { "name": "value", "type": { "code": "BOOL" } } ], "documentation": "\n\nWhether the UI object is visible.\n\n" }, "Canvas_AddPanel": { "id": 12, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Panel" }, "return_is_nullable": false, "documentation": "\n\nCreate a new container for user interface elements.\n\nWhether the panel is visible.\n" }, "Canvas_AddText": { "id": 13, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } }, { "name": "content", "type": { "code": "STRING" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Text" }, "return_is_nullable": false, "documentation": "\n\nAdd text to the canvas.\n\nThe text.\nWhether the text is visible.\n" }, "Canvas_AddInputField": { "id": 14, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "InputField" }, "return_is_nullable": false, "documentation": "\n\nAdd an input field to the canvas.\n\nWhether the input field is visible.\n" }, "Canvas_AddButton": { "id": 15, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } }, { "name": "content", "type": { "code": "STRING" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Button" }, "return_is_nullable": false, "documentation": "\n\nAdd a button to the canvas.\n\nThe label for the button.\nWhether the button is visible.\n" }, "Canvas_Remove": { "id": 16, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } } ], "documentation": "\n\nRemove the UI object.\n\n" }, "Canvas_get_RectTransform": { "id": 17, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } } ], "return_type": { "code": "CLASS", "service": "UI", "name": "RectTransform" }, "return_is_nullable": false, "documentation": "\n\nThe rect transform for the canvas.\n\n" }, "Canvas_get_Visible": { "id": 18, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } } ], "return_type": { "code": "BOOL" }, "return_is_nullable": false, "documentation": "\n\nWhether the UI object is visible.\n\n" }, "Canvas_set_Visible": { "id": 19, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Canvas" } }, { "name": "value", "type": { "code": "BOOL" } } ], "documentation": "\n\nWhether the UI object is visible.\n\n" }, "InputField_Remove": { "id": 20, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } } ], "documentation": "\n\nRemove the UI object.\n\n" }, "InputField_get_RectTransform": { "id": 21, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } } ], "return_type": { "code": "CLASS", "service": "UI", "name": "RectTransform" }, "return_is_nullable": false, "documentation": "\n\nThe rect transform for the input field.\n\n" }, "InputField_get_Value": { "id": 22, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } } ], "return_type": { "code": "STRING" }, "return_is_nullable": false, "documentation": "\n\nThe value of the input field.\n\n" }, "InputField_set_Value": { "id": 23, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } }, { "name": "value", "type": { "code": "STRING" } } ], "documentation": "\n\nThe value of the input field.\n\n" }, "InputField_get_Text": { "id": 24, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Text" }, "return_is_nullable": false, "documentation": "\n\nThe text component of the input field.\n\n\nUse to get and set the value in the field.\nThis object can be used to alter the style of the input field's text.\n\n" }, "InputField_get_Changed": { "id": 25, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } } ], "return_type": { "code": "BOOL" }, "return_is_nullable": false, "documentation": "\n\nWhether the input field has been changed.\n\n\nThis property is set to true when the user modifies the value of the input field.\nA client script should reset the property to false in order to detect subsequent changes.\n\n" }, "InputField_set_Changed": { "id": 26, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } }, { "name": "value", "type": { "code": "BOOL" } } ], "documentation": "\n\nWhether the input field has been changed.\n\n\nThis property is set to true when the user modifies the value of the input field.\nA client script should reset the property to false in order to detect subsequent changes.\n\n" }, "InputField_get_Visible": { "id": 27, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } } ], "return_type": { "code": "BOOL" }, "return_is_nullable": false, "documentation": "\n\nWhether the UI object is visible.\n\n" }, "InputField_set_Visible": { "id": 28, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "InputField" } }, { "name": "value", "type": { "code": "BOOL" } } ], "documentation": "\n\nWhether the UI object is visible.\n\n" }, "Panel_AddPanel": { "id": 29, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Panel" }, "return_is_nullable": false, "documentation": "\n\nCreate a panel within this panel.\n\nWhether the new panel is visible.\n" }, "Panel_AddText": { "id": 30, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } }, { "name": "content", "type": { "code": "STRING" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Text" }, "return_is_nullable": false, "documentation": "\n\nAdd text to the panel.\n\nThe text.\nWhether the text is visible.\n" }, "Panel_AddInputField": { "id": 31, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "InputField" }, "return_is_nullable": false, "documentation": "\n\nAdd an input field to the panel.\n\nWhether the input field is visible.\n" }, "Panel_AddButton": { "id": 32, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } }, { "name": "content", "type": { "code": "STRING" } }, { "name": "visible", "type": { "code": "BOOL" }, "default_value": "AQ==" } ], "return_type": { "code": "CLASS", "service": "UI", "name": "Button" }, "return_is_nullable": false, "documentation": "\n\nAdd a button to the panel.\n\nThe label for the button.\nWhether the button is visible.\n" }, "Panel_Remove": { "id": 33, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } } ], "documentation": "\n\nRemove the UI object.\n\n" }, "Panel_get_RectTransform": { "id": 34, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } } ], "return_type": { "code": "CLASS", "service": "UI", "name": "RectTransform" }, "return_is_nullable": false, "documentation": "\n\nThe rect transform for the panel.\n\n" }, "Panel_get_Visible": { "id": 35, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } } ], "return_type": { "code": "BOOL" }, "return_is_nullable": false, "documentation": "\n\nWhether the UI object is visible.\n\n" }, "Panel_set_Visible": { "id": 36, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Panel" } }, { "name": "value", "type": { "code": "BOOL" } } ], "documentation": "\n\nWhether the UI object is visible.\n\n" }, "RectTransform_get_Position": { "id": 37, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nPosition of the rectangles pivot point relative to the anchors.\n\n" }, "RectTransform_set_Position": { "id": 38, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nPosition of the rectangles pivot point relative to the anchors.\n\n" }, "RectTransform_get_LocalPosition": { "id": 39, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nPosition of the rectangles pivot point relative to the anchors.\n\n" }, "RectTransform_set_LocalPosition": { "id": 40, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nPosition of the rectangles pivot point relative to the anchors.\n\n" }, "RectTransform_get_Size": { "id": 41, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nWidth and height of the rectangle.\n\n" }, "RectTransform_set_Size": { "id": 42, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nWidth and height of the rectangle.\n\n" }, "RectTransform_get_UpperRight": { "id": 43, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nPosition of the rectangles upper right corner relative to the anchors.\n\n" }, "RectTransform_set_UpperRight": { "id": 44, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nPosition of the rectangles upper right corner relative to the anchors.\n\n" }, "RectTransform_get_LowerLeft": { "id": 45, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nPosition of the rectangles lower left corner relative to the anchors.\n\n" }, "RectTransform_set_LowerLeft": { "id": 46, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nPosition of the rectangles lower left corner relative to the anchors.\n\n" }, "RectTransform_set_Anchor": { "id": 47, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nSet the minimum and maximum anchor points as a fraction of the size of the parent rectangle.\n\n" }, "RectTransform_get_AnchorMax": { "id": 48, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nThe anchor point for the lower left corner of the rectangle defined as a fraction of the size of the parent rectangle.\n\n" }, "RectTransform_set_AnchorMax": { "id": 49, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nThe anchor point for the lower left corner of the rectangle defined as a fraction of the size of the parent rectangle.\n\n" }, "RectTransform_get_AnchorMin": { "id": 50, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nThe anchor point for the upper right corner of the rectangle defined as a fraction of the size of the parent rectangle.\n\n" }, "RectTransform_set_AnchorMin": { "id": 51, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nThe anchor point for the upper right corner of the rectangle defined as a fraction of the size of the parent rectangle.\n\n" }, "RectTransform_get_Pivot": { "id": 52, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nLocation of the pivot point around which the rectangle rotates, defined as a fraction of the size of the rectangle itself.\n\n" }, "RectTransform_set_Pivot": { "id": 53, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nLocation of the pivot point around which the rectangle rotates, defined as a fraction of the size of the rectangle itself.\n\n" }, "RectTransform_get_Rotation": { "id": 54, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nRotation, as a quaternion, of the object around its pivot point.\n\n" }, "RectTransform_set_Rotation": { "id": 55, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nRotation, as a quaternion, of the object around its pivot point.\n\n" }, "RectTransform_get_Scale": { "id": 56, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nScale factor applied to the object in the x, y and z dimensions.\n\n" }, "RectTransform_set_Scale": { "id": 57, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "RectTransform" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nScale factor applied to the object in the x, y and z dimensions.\n\n" }, "Text_Remove": { "id": 58, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "documentation": "\n\nRemove the UI object.\n\n" }, "Text_get_RectTransform": { "id": 59, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "CLASS", "service": "UI", "name": "RectTransform" }, "return_is_nullable": false, "documentation": "\n\nThe rect transform for the text.\n\n" }, "Text_get_AvailableFonts": { "id": 60, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "LIST", "types": [ { "code": "STRING" } ] }, "return_is_nullable": false, "documentation": "\n\nA list of all available fonts.\n\n" }, "Text_get_Content": { "id": 61, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "STRING" }, "return_is_nullable": false, "documentation": "\n\nThe text string\n\n" }, "Text_set_Content": { "id": 62, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "STRING" } } ], "documentation": "\n\nThe text string\n\n" }, "Text_get_Font": { "id": 63, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "STRING" }, "return_is_nullable": false, "documentation": "\n\nName of the font\n\n" }, "Text_set_Font": { "id": 64, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "STRING" } } ], "documentation": "\n\nName of the font\n\n" }, "Text_get_Size": { "id": 65, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "SINT32" }, "return_is_nullable": false, "documentation": "\n\nFont size.\n\n" }, "Text_set_Size": { "id": 66, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "SINT32" } } ], "documentation": "\n\nFont size.\n\n" }, "Text_get_Style": { "id": 67, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "ENUMERATION", "service": "UI", "name": "FontStyle" }, "return_is_nullable": false, "documentation": "\n\nFont style.\n\n" }, "Text_set_Style": { "id": 68, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "ENUMERATION", "service": "UI", "name": "FontStyle" } } ], "documentation": "\n\nFont style.\n\n" }, "Text_get_Alignment": { "id": 69, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "ENUMERATION", "service": "UI", "name": "TextAnchor" }, "return_is_nullable": false, "documentation": "\n\nAlignment.\n\n" }, "Text_set_Alignment": { "id": 70, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "ENUMERATION", "service": "UI", "name": "TextAnchor" } } ], "documentation": "\n\nAlignment.\n\n" }, "Text_get_LineSpacing": { "id": 71, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "FLOAT" }, "return_is_nullable": false, "documentation": "\n\nLine spacing.\n\n" }, "Text_set_LineSpacing": { "id": 72, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "FLOAT" } } ], "documentation": "\n\nLine spacing.\n\n" }, "Text_get_Color": { "id": 73, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] }, "return_is_nullable": false, "documentation": "\n\nSet the color\n\n" }, "Text_set_Color": { "id": 74, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "TUPLE", "types": [ { "code": "DOUBLE" }, { "code": "DOUBLE" }, { "code": "DOUBLE" } ] } } ], "documentation": "\n\nSet the color\n\n" }, "Text_get_Visible": { "id": 75, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } } ], "return_type": { "code": "BOOL" }, "return_is_nullable": false, "documentation": "\n\nWhether the UI object is visible.\n\n" }, "Text_set_Visible": { "id": 76, "parameters": [ { "name": "this", "type": { "code": "CLASS", "service": "UI", "name": "Text" } }, { "name": "value", "type": { "code": "BOOL" } } ], "documentation": "\n\nWhether the UI object is visible.\n\n" } }, "classes": { "Button": { "documentation": "\n\nA text label. See .\n\n" }, "Canvas": { "documentation": "\n\nA canvas for user interface elements. See and .\n\n" }, "InputField": { "documentation": "\n\nAn input field. See .\n\n" }, "Panel": { "documentation": "\n\nA container for user interface elements. See .\n\n" }, "RectTransform": { "documentation": "\n\nA Unity engine Rect Transform for a UI object.\nSee the Unity manual for more details.\n\n" }, "Text": { "documentation": "\n\nA text label. See .\n\n" } }, "enumerations": { "FontStyle": { "documentation": "\n\nFont style.\n\n", "values": [ { "name": "Normal", "value": 0, "documentation": "\n\nNormal.\n\n" }, { "name": "Bold", "value": 1, "documentation": "\n\nBold.\n\n" }, { "name": "Italic", "value": 2, "documentation": "\n\nItalic.\n\n" }, { "name": "BoldAndItalic", "value": 3, "documentation": "\n\nBold and italic.\n\n" } ] }, "MessagePosition": { "documentation": "\n\nMessage position.\n\n", "values": [ { "name": "BottomCenter", "value": 0, "documentation": "\n\nBottom center.\n\n" }, { "name": "TopCenter", "value": 1, "documentation": "\n\nTop center.\n\n" }, { "name": "TopLeft", "value": 2, "documentation": "\n\nTop left.\n\n" }, { "name": "TopRight", "value": 3, "documentation": "\n\nTop right.\n\n" } ] }, "TextAlignment": { "documentation": "\n\nText alignment.\n\n", "values": [ { "name": "Left", "value": 0, "documentation": "\n\nLeft aligned.\n\n" }, { "name": "Right", "value": 1, "documentation": "\n\nRight aligned.\n\n" }, { "name": "Center", "value": 2, "documentation": "\n\nCenter aligned.\n\n" } ] }, "TextAnchor": { "documentation": "\n\nText alignment.\n\n", "values": [ { "name": "LowerCenter", "value": 0, "documentation": "\n\nLower center.\n\n" }, { "name": "LowerLeft", "value": 1, "documentation": "\n\nLower left.\n\n" }, { "name": "LowerRight", "value": 2, "documentation": "\n\nLower right.\n\n" }, { "name": "MiddleCenter", "value": 3, "documentation": "\n\nMiddle center.\n\n" }, { "name": "MiddleLeft", "value": 4, "documentation": "\n\nMiddle left.\n\n" }, { "name": "MiddleRight", "value": 5, "documentation": "\n\nMiddle right.\n\n" }, { "name": "UpperCenter", "value": 6, "documentation": "\n\nUpper center.\n\n" }, { "name": "UpperLeft", "value": 7, "documentation": "\n\nUpper left.\n\n" }, { "name": "UpperRight", "value": 8, "documentation": "\n\nUpper right.\n\n" } ] } }, "exceptions": {} } }