|
|
| Line 1: |
Line 1: |
| − | =Properties=
| + | This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/suiimage |
| − | | + | |
| − | {{ScriptFunction|float|AlphaHitTestMinimumThreshold|{ get; set; }|The alpha threshold specifies the minimum alpha a pixel must have for the event to considered a "hit" on the Image.
| + | |
| − | Alpha values less than the threshold will cause raycast events to pass through the Image. An value of 1 would cause only fully opaque pixels to register raycast events on the Image. The alpha tested is retrieved from the image sprite only, while the alpha of the Image Graphic.color is disregarded.
| + | |
| − | | + | |
| − | alphaHitTestMinimumThreshold defaults to 0; all raycast events inside the Image rectangle are considered a hit. In order for greater than 0 to values to work, the sprite used by the Image must have readable pixels. This can be achieved by enabling Read/Write enabled in the advanced Texture Import Settings for the sprite and disabling atlassing for the sprite.|5= <pre>Space.Host.ExecutingObject.UIImage.AlphaHitTestMinimumThreshold = 0</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|SColor|Color|{ get; set; }|Default Color of UIImage|5= <pre>Space.Host.ExecutingObject.UIImage.Color= Color.Red</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|FillAmount|{ get; set; }|Amount of the Image shown|5= <pre>Space.Host.ExecutingObject.UIImage.FillAmount = 0.5</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|FillCenter|{ get; set; }|Whether or not to render the center|5= <pre>Space.Host.ExecutingObject.UIImage.FillCenter = true</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|FillClockwise|{ get; set; }|Whether the Image should be filled clockwise (true) or counter-clockwise (false).|5= <pre>Space.Host.ExecutingObject.UIImage.FillClockwise = true</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|int|FillOrigin|{ get; set; }|Controls the origin point of the Fill process.|5= <pre>Space.Host.ExecutingObject.UIImage.FillOrigin = 0</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|HasBorder|{ get; }|True if the sprite used has borders.|5= <pre>imgHasBorder = Space.Host.ExecutingObject.UIImage.HasBorder </pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|SMaterial|Material|{ get; set; }|The specified Material used by this Image. The default Material is used instead if one wasn't specified.|5= <pre>imageMaterial = Space.Host.ExecutingObject.UIImage.Material </pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|PreserveAspect|{ get; set; }|Whether this image should preserve its Sprite aspect ratio.|5= <pre>Space.Host.ExecutingObject.UIImage.PreserveAspect = true </pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|SResource|Sprite|{ get; set; }|The sprite that is used to render this image.|5= <pre>imageSprite= Space.Host.ExecutingObject.UIImage.Sprite </pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|FlexibleHeight|{ get;}|The extra relative height this UIImage should be allocated if there is additional available space. (Used by the Layout system) |5= <pre>flexHeight = Space.Host.ExecutingObject.UIImage.FlexibleHeight</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|FlexibleWidth|{ get;}|The extra relative width this UIImage should be allocated if there is additional available space. (Used by the Layout system)|5= <pre>flexWidth = Space.Host.ExecutingObject.UIImage.FlexibleWidth</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|MinHeight|{ get;}|The minimum height this UIImage may be allocated.(Used by the Layout system).|5= <pre>minHeight = Space.Host.ExecutingObject.UIImage.MinHeight</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|MinWidth|{ get;}|The minimum width this UIImage may be allocated. (Used by the Layout system).|5= <pre>minWidth = Space.Host.ExecutingObject.UIImage.MinWidth</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|PreferredHeight|{ get;}|The preferred height this UIImage should be allocated if there is sufficient space. (Used by the Layout system)|5= <pre>prefHeight = Space.Host.ExecutingObject.UIImage.PreferredHeight</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|bool|PreferredWidth|{ get; }|The preferred width this UIImage should be allocated if there is sufficient space. (Used by the Layout system)|5= <pre>prefWidth = Space.Host.ExecutingObject.UIImage.PreferredWidth</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|int|LayoutPriority|{get;}|The layout priority of this UIText component.(Used by the Layout system.)|5=<pre>layoutPrio = Space.Host.ExecutingObject.UIImage.LayoutPriority)</pre>}}
| + | |
| − | | + | |
| − | {{ScriptFunction|float|PixelsPerUnit|{get;}|Provides information about how fonts are scale to the screen.
| + | |
| − | | + | |
| − | For dynamic fonts, the value is equivalent to the scale factor of the canvas. For non-dynamic fonts, the value is calculated from the requested text size and the size from the font.|5=<pre>ppUnit = Space.Host.ExecutingObject.UIImage.PixelsPerUnit</pre>}}
| + | |
| − | | + | |
| − | | + | |
| − | | + | |
| − | {{Scripting Navbox}}
| + | |
