Class PaperSpriteComponent
A component that handles rendering and collision for a single instance of a UPaperSprite asset.
Inheritance
System.Object
PaperSpriteComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.Paper2D
Assembly: UE4DotNet.dll
Syntax
public class PaperSpriteComponent : MeshComponentRemarks
This component is created when you drag a sprite asset from the content browser into a Blueprint, or contained inside of the actor created when you drag one into the level.
@see UPrimitiveComponent, UPaperSprite
Properties
| Improve this Doc View SourceDefaultObject
Get UE4 Default Object for this Class
Declaration
public static PaperSpriteComponent DefaultObject { get; }Property Value
| Type | Description |
|---|---|
| PaperSpriteComponent |
SourceSprite
The sprite asset used by this component
Declaration
public PaperSprite SourceSprite { get; }Property Value
| Type | Description |
|---|---|
| PaperSprite |
SpriteColor
The color of the sprite (passed to the sprite material as a vertex color)
Declaration
public LinearColor SpriteColor { get; }Property Value
| Type | Description |
|---|---|
| LinearColor |
StaticClass
Get UE4 Class
Declaration
public static Class StaticClass { get; }Property Value
| Type | Description |
|---|---|
| Class |
Methods
| Improve this Doc View SourceGetSprite()
Gets the PaperSprite used by this instance.
Declaration
public PaperSprite GetSprite()Returns
| Type | Description |
|---|---|
| PaperSprite |
New(UObject, Name)
Spawn an object of this class
Declaration
public static PaperSpriteComponent New(UObject obj = null, Name name = default(Name))Parameters
| Type | Name | Description |
|---|---|---|
| UObject | obj | |
| Name | name |
Returns
| Type | Description |
|---|---|
| PaperSpriteComponent |
SetSprite(PaperSprite)
Change the PaperSprite used by this instance.
Declaration
public bool SetSprite(PaperSprite NewSprite)Parameters
| Type | Name | Description |
|---|---|---|
| PaperSprite | NewSprite |
Returns
| Type | Description |
|---|---|
| System.Boolean |
SetSpriteColor(LinearColor)
Set color of the sprite
Declaration
public void SetSpriteColor(LinearColor NewColor)Parameters
| Type | Name | Description |
|---|---|---|
| LinearColor | NewColor |
Operators
| Improve this Doc View SourceImplicit(IntPtr to PaperSpriteComponent)
Convert from IntPtr to UObject
Declaration
public static implicit operator PaperSpriteComponent(IntPtr p)Parameters
| Type | Name | Description |
|---|---|---|
| System.IntPtr | p |
Returns
| Type | Description |
|---|---|
| PaperSpriteComponent |