Serializable url for native asset. For internal usage.
内部使用。
Whether the asset is loaded or not
UV for quad vertices
UV for sliced 9 vertices
Vertex list for the mesh type sprite frame
Indicates whether its dependent raw assets can support deferred load if the owner scene (or prefab) is marked as asyncLoadAssets.
Indicates whether its native object should be preloaded from native url.
The underlying native asset of this asset if one is available.
This property can be used to access additional details or functionality releated to the asset.
This property will be initialized by the loader if _native is available.
The underlying native asset of this asset if one is available.
This property can be used to access additional details or functionality releated to the asset.
This property will be initialized by the loader if _native is available.
The uuid of the atlas asset, if exist
The uuid of the atlas asset, if exist
The pixel height of the sprite frame
Bottom border distance of sliced 9 rect.
Bottom border distance of sliced 9 rect.
Left border distance of sliced 9 rect.
Left border distance of sliced 9 rect.
Right border distance of sliced 9 rect.
Right border distance of sliced 9 rect.
Top border distance of sliced 9 rect.
Top border distance of sliced 9 rect.
Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame.
So isValid will return false from the next frame, while isValid in the current frame will still be true.
If you want to determine whether the current frame has called destroy, use isValid(obj, true),
but this is often caused by a particular logical requirements, which is not normally required.
The name of the object.
The name of the object.
Returns the url of this asset's native object, if none it will returns an empty string.
The offset of the sprite frame center. Sprite frame in an atlas texture could be trimmed for clipping the transparent pixels, so the trimmed rect is smaller than the original one, the offset defines the distance from the original center to the trimmed center.
The offset of the sprite frame center. Sprite frame in an atlas texture could be trimmed for clipping the transparent pixels, so the trimmed rect is smaller than the original one, the offset defines the distance from the original center to the trimmed center.
Returns the rect of the sprite frame in the texture. If it's an atlas texture, a transparent pixel area is proposed for the actual mapping of the current texture.
Returns the rect of the sprite frame in the texture. If it's an atlas texture, a transparent pixel area is proposed for the actual mapping of the current texture.
Whether the content of sprite frame is rotated.
Whether the content of sprite frame is rotated.
The texture of the sprite frame, could be TextureBase or RenderTexture
The texture of the sprite frame, could be TextureBase or RenderTexture
The pixel width of the sprite frame
Clear all references in the instance.
NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }
Set native file name for this asset.
Check whether the rect of the sprite frame is out of the texture boundary
Create a new node using this asset in the scene.
If this type of asset dont have its corresponding node type, this method should be null.
Trigger an event directly with the event name and necessary arguments.
event type
Gets the sampler resource of its texture
Gets the related GFXTexture resource
Checks whether there is correspond event listener registered on the given event.
Event type.
Callback function when event triggered.
Callback callee.
Returns whether the sprite frame is rotated in the texture.
Removes the listeners previously registered with the same type, callback, target and or useCapture, if only type is passed as parameter, all listeners registered with that type will be removed.
A string representing the event type being removed.
The callback to remove.
Register an callback of a specific event type on the EventTarget.
This type of event should be triggered via emit.
A string representing the event type to listen for.
The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).
The target (this object) to invoke the callback, can be null
Register an callback of a specific event type on the EventTarget, the callback will remove itself after the first time it is triggered.
A string representing the event type to listen for.
The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).
Removes all callbacks registered in a certain event type or all callbacks registered with a certain target
The event type or target with which the listeners will be removed
Resets the sprite frame data
SpriteFrame initialization information
应 AssetDB 要求提供这个方法。 返回一个序列化后的对象
Sets the offset of the frame
The new offset
Sets the original size before trimmed.
The new original size
Sets the rect of the sprite frame in the texture.
Set whether the sprite frame is rotated in the texture.
Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
The target to be searched for all related listeners
Returns whether the texture have been loaded.
Returns the string representation of the object.
The Asset object overrides the toString() method of the Object object.
JavaScript calls the toString() method automatically
when an asset is to be represented as a text value or when a texture is referred to in a string concatenation.
For assets of the native type, it will return this.nativeUrl.
Otherwise, an empty string is returned.
This method may be overwritten by subclasses.
Create a SpriteFrame object by an image asset or an native image asset
ImageAsset or ImageSource, ImageSource support HTMLCanvasElement HTMLImageElement IMemoryImageSource
应 AssetDB 要求提供这个方法。
内部使用。
Generated using TypeDoc
A
SpriteFramesupport several typesimport { loader } from 'cc'; // First way to use a SpriteFrame const url = "assets/PurpleMonster/icon/spriteFrame"; loader.loadRes(url, (err, spriteFrame) => { const node = new Node("New Sprite"); const sprite = node.addComponent(Sprite); sprite.spriteFrame = spriteFrame; node.parent = self.node; }); // Second way to use a SpriteFrame const self = this; const url = "test_assets/PurpleMonster"; loader.loadRes(url, (err, imageAsset) => { if(err){ return; } const node = new Node("New Sprite"); const sprite = node.addComponent(Sprite); const spriteFrame = new SpriteFrame(); const tex = imageAsset._texture; spriteFrame.texture = tex; sprite.spriteFrame = spriteFrame; node.parent = self.node; }); // Third way to use a SpriteFrame const self = this; const cameraComp = this.getComponent(Camera); const renderTexture = new RenderTexture(); rendetTex.reset({ width: 512, height: 512, depthStencilFormat: RenderTexture.DepthStencilFormat.DEPTH_24_STENCIL_8 }); cameraComp.targetTexture = renderTexture; const spriteFrame = new SpriteFrame(); spriteFrame.texture = renderTexture;