The address of the skin resource.
Under the premise that this object is non-penetrable (mouseThrough is false), specify whether the mouse event capture detection prioritizes this object. When set to true, the object itself is prioritized for detection. When set to false, the child objects are prioritized. When set to prioritize the object itself, the object is detected first. If the object itself is not hit, the detection is directly interrupted, indicating that no target was hit. If the object itself is hit, further recursive detection is performed on its child objects until the final mouse hit target is found or all child nodes have been checked. When set to prioritize child objects, the child objects are recursively detected first. If a child object is hit, the detection is interrupted and the hit target is obtained. If all child nodes have been checked and no child object is hit, then the detection checks if the object itself is hit. In most cases, prioritizing the detection of child objects is advisable unless the developer does not care about the mouse event detection results of the current node's child nodes. For example, when child nodes are certainly within the width and height range of the parent node's container, there is no need for recursive detection layer by layer if the mouse click does not occur within the parent node's area. Using this property appropriately can reduce the nodes for mouse event detection and improve performance.
在本对象为不可穿透（mouseThrough为false）的前提下，指定鼠标事件捕获检测是否优先检测本对象。为true时优先检测本对象，为false时优先检测子对象。
优先检测本对象时，如果本对象没有被检测命中，会中断检测，表示没有命中目标；如果本对象被检测命中，则进一步递归检测其子对象，直到找到鼠标最终的命中目标或所有子节点都检测完毕。
优先检测子对象时，先递归检测其子对象，如果子对象被检测命中，则中断检测，获得命中目标。如果所有子节点都检测完毕，仍未检测命中任何子对象，最后再检测本对象是否被命中；
大多数情况下需要优先检测子对象，除非开发者并不关心当前节点的子节点的鼠标事件检测结果，也就是以当前节点作为其子节点的鼠标事件检测依据。例如，子节点肯定在父节点的容器宽高范围内，当鼠标点击不发生在父节点范围内的区域时，就不必层层递归检测了。
合理使用本属性，能减少鼠标事件检测的节点，提高性能。
For non-UI component display object nodes (container objects or display objects without image resources), specifies whether the mouse events penetrate this object's collision detection. true means the object is penetrable, false means it is not penetrable.
When penetrable, the engine will no longer detect this object and will recursively check its child objects until it finds the target object or misses all objects.
When not penetrable, the node's width and height define the mouse collision area (a non-penetrable rectangular area). If the rectangular collision area does not meet the requirements, you can use the drawing area of the hit area as the collision area. The hit area takes precedence over width and height of node as the non-penetrable mouse collision area.
Note that for UI object nodes with a set skin property, once a skin texture resource is set, this property becomes ineffective, and the rectangular area drawn by the texture will always be non-penetrable unless it does not accept mouse events or a non-clickable area is set.
静态easeWhether to automatically calculate the width and height of the node. The default value is false, which does not automatically calculate and offers better performance.
If you want to get the width and height based on the drawn content, you can set this property to true, or use the getBounds method to obtain them, which has some impact on performance.
Specifies whether the display object is cached as a static image. When cacheAs is set, changes in child objects will automatically update the cache. You can also manually call the reCache method to update the cache. It is recommended to cache "complex content" that does not change frequently as a static image to greatly improve rendering performance. cacheAs has three values: "none", "normal", and "bitmap". The default is "none," which does not perform any caching. When set to "normal," command caching is used. When set to "bitmap," renderTarget caching is used. Disadvantages of the renderTarget caching mode: it creates additional renderTarget objects, increasing memory overhead, has a maximum cache area limit of 2048, and can increase CPU overhead with constant redrawing. Advantages: it significantly reduces draw calls and provides the highest rendering performance. Disadvantages of the command caching mode: it only reduces node traversal and command organization and does not reduce the number of draw calls, resulting in moderate performance. Advantages: it has no additional memory overhead and does not require renderTarget support.
指定显示对象是否缓存为静态图像，cacheAs 时，子对象发生变化，会自动重新缓存，同时也可以手动调用 reCache 方法更新缓存。 建议把不经常变化的“复杂内容”缓存为静态图像，能极大提高渲染性能。cacheAs 有 "none"，"normal" 和 "bitmap" 三个值可选。 默认为 "none"，不做任何缓存。 当值为 "normal" 时，使用命令缓存。 当值为 "bitmap" 时，使用 renderTarget 缓存。 renderTarget 缓存模式缺点：会额外创建 renderTarget 对象，增加内存开销，缓存面积有最大 2048 限制，不断重绘时会增加 CPU 开销。优点：大幅减少 drawcall，渲染性能最高。 命令缓存模式缺点：只会减少节点遍历及命令组织，不会减少 drawcall 数，性能中等。优点：没有额外内存开销，无需 renderTarget 支持。
An array of component instances.
Draw call optimization: when set to true, draw call optimization is enabled. During engine rendering, all text is automatically brought to the top layer to avoid interruptions by text when drawing images from the same atlas, thus reducing the number of draw calls. Enabling this will cause text to be non-obstructable. Use this feature cautiously if your project requires text to be obstructed.
You can set a rectangular area as the clickable region, or set a HitArea instance as the clickable region. The HitArea can have both clickable and non-clickable areas defined. If the hitArea is not set, the mouse collision detection will be based on the area formed by the width and height of the object.
The scroll rectangle range of the display object, with a clipping effect (if you only want to limit the rendering area of child objects, please use viewport). Differences between srollRect and viewport:
The size grid of the texture. The size grid is a 3x3 division of the texture, allowing it to be scaled without distorting the corners and edges. The array contains five values representing the top, right, bottom, and left margins, and whether to repeat the fill (0: no repeat, 1: repeat). The values are separated by commas. For example: "6,6,6,6,1".
Mouse hover prompt.
It can be assigned as text String or function Handler to implement custom style mouse prompts and parameter carrying, etc.
private var _testTips:TestTipsUI = new TestTipsUI();
private function testTips():void {
//Simple mouse prompt
btn2.toolTip = "This is a mouse tip<b>Bold</b><br>New line";
//Custom mouse prompt
btn1.toolTip = showTips1;
//Custom mouse prompt with parameters
clip.toolTip = new Handler(this,showTips2, ["clip"]);
}
private function showTips1():void {
_testTips.label.text = "This is button[" + btn1.label + "]";
tip.addChild(_testTips);
}
private function showTips2(name:String):void {
_testTips.label.text = "This is " + name;
tip.addChild(_testTips);
}
The viewport size. Child objects outside the viewport will not be rendered (if you want to achieve a clipping effect, please use scrollRect). Proper use can improve rendering performance. For example, map tiles composed of small images will not render small images outside the viewport. The default value is null. The differences between scrollRect and viewport:
A variable number of child nodes to be added.
The callback function.
The parameters passed to the callback function.
The specified node.
A Boolean value indicating whether the current node contains the specified node.
The rendering context reference.
The X-axis coordinate.
The Y-axis coordinate.
The width of the canvas.
The height of the canvas.
The X-axis offset for drawing.
The Y-axis offset for drawing.
The HTMLCanvas object.
The width of the canvas.
The height of the canvas.
The X-axis offset for drawing.
The Y-axis offset for drawing.
The render target.
A boolean indicating whether to draw the render rectangle. When true, it starts drawing from (0,0) of the render texture and subtracts the offset of the cache rectangle. When false, it keeps the sprite's original relative position for drawing.
Optional. If true, the texture will be flipped vertical. Default is false.
The drawn RenderTexture2D object.
The width of the canvas.
The height of the canvas.
The X-axis offset for drawing.
The Y-axis offset for drawing.
The render target.
A boolean indicating whether to draw the render rectangle. When true, it starts drawing from (0,0) of the render texture and subtracts the offset of the cache rectangle. When false, it keeps the sprite's original relative position for drawing.
The drawn Texture or RenderTexture2D object.
The type of event.
可选data: any(Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.
True if there are listeners for this event type, false otherwise.
The interval between executions, in frames.
The execution scope of the callback function (this).
The callback function.
The parameters passed to the callback function.
Whether to override the previous delayed execution. The default value is true.
The delay time, in frames.
The execution scope of the callback function (this).
The callback function.
The parameters passed to the callback function.
Whether to override the previous delayed execution. The default value is true.
Recalculate and update the layout of the object.
This method will reset the horizontal and vertical layout of the object based on the _widget property.
It will calculate the position and size of the object according to the layout rules specified by the _widget property,
such as left, right, top, bottom, centerX, and centerY.
The screen point information.
The global coordinate point.
可选createNewPoint: boolean(Optional) Whether to create a new Point object as the return value. The default is false, which uses the input point object as the return value to reduce object creation overhead.
可选globalNode: SpriteThe global node, default is Laya.stage.
The converted local coordinate point.
The node to check.
True if this node is an ancestor of the given node, false otherwise.
The image URL.
可选complete: Handler(Optional) The callback function when loading is complete.
Returns the Sprite object itself.
The local coordinate point.
可选createNewPoint: boolean(Optional) Whether to create a new Point object as the return value. The default is false, which uses the input point object as the return value to reduce object creation overhead.
可选globalNode: SpriteThe global node, default is Laya.stage
The converted global coordinate point.
The type of event.
The listener function.
This EventDispatcher object.
The type of event.
The execution scope of the event listener function.
可选listener: FunctionThe listener function.
可选args: any[]This EventDispatcher object.
可选type: string(Optional) The type of event. If the value is null, all types of listeners on this object are removed.
This EventDispatcher object.
The type of event.
The listener function.
This EventDispatcher object.
The type of event.
The execution scope of the event listener function.
The listener function.
可选args: any[](Optional) The callback parameters of the event listener function.
This EventDispatcher object.
The type of event.
The listener function.
This EventDispatcher object.
The type of event.
The execution scope of the event listener function.
The listener function.
可选args: any[](Optional) The callback parameters of the event listener function.
This EventDispatcher object.
X-axis pivot point.
Y-axis pivot point.
The object itself.
X-axis coordinate.
Y-axis coordinate.
The object itself.
The node itself.
The rendering context reference.
The X-axis coordinate.
The Y-axis coordinate. The meaning of x and y is complex. Without rotation, it is the world position of the current node. If any parent node has rotation, x and y will be reset to [0,0] there and then accumulated again. So, x and y can be considered as the cumulative value from the current node to a node with rotation (or the root node).
X-axis scale ratio.
Y-axis scale ratio.
The object itself.
The Graphics object to set.
Whether to set the Graphics object to the belonging node (i.e., transfer the ownership of the Graphics object to the Sprite). If true, the Sprite will be responsible for destroying the Graphics object when it's no longer needed.
The bounds rectangle.
Width value.
Height value.
The object itself.
Horizontal skew angle.
Vertical skew angle.
The object itself.
可选area: Rectangle(Optional) The drag area, which is the active area of the object's registration point (excluding the object's width and height).
可选hasInertia: boolean(Optional) Whether the object has inertia when the mouse is released. The default is false.
可选elasticDistance: number(Optional) The distance value of the elastic effect. A value of 0 means no elastic effect. The default is 0.
可选elasticBackTime: number(Optional) The bounce-back time for the elastic effect in milliseconds. The default is 300 milliseconds.
可选data: any(Optional) The data carried by the drag event.
可选ratio: number(Optional) The inertia damping coefficient, which affects the strength and duration of inertia.
Forces a drag action on the scrollbar. Normally, dragging can only be done by holding the scrollbar itself. If you need to force drag outside the scrollbar object, you can achieve this by calling this method. For example, if the mouse is continuously held on a button object outside the scrollbar and this method is called, then sliding the mouse will have the same effect as dragging the scrollbar.
The interval between executions, in milliseconds.
The execution scope of the callback function (this).
The callback function.
The parameters passed to the callback function.
Whether to override the previous delayed execution. The default value is true.
Whether the callback should be executed when the timer jumps frames. The default value is false. If set to true, the callback will be executed multiple times in a single frame if possible, for performance reasons.
The delay time, in milliseconds.
The execution scope of the callback function (this).
The callback function.
The parameters passed to the callback function.
Whether to override the previous delayed execution. The default value is true.
静态from
En
Use the
HScrollBar(horizontalScrollBar) control to control the displayed data portion when there is too much data to display completely in the display area.Zh
使用
HScrollBar（水平ScrollBar）控件，可以在因数据太多而不能在显示区域完全显示时控制显示的数据部分。