SpriteGUIRendererComponent

UI에 스프라이트 또는 애니메이션 클립을 출력합니다.

# Properties

[{"index":"SpriteAnimClipPlayType AnimClipPlayType","0":"애니메이션 클립의 재생 방식을 설정합니다. 한 번만 재생, 반복 재생 등을 설정할 수 있습니다."}]

[{"index":"int32 EndFrameIndex","0":"애니메이션 출력 시의 마지막 프레임 번호입니다."}]

[{"index":"boolean IgnoreMapLayerCheck (Sync)","0":"SortingLayer에 Map Layer 이름을 지정했을 때 자동 치환을 수행하지 않습니다."}]

[{"index":"DataRef ImageRUID","0":"화면에 표시될 이미지 RUID입니다."}]

[{"index":"Vector2 LocalPosition","0":"이미지 출력 위치입니다."}]

[{"index":"Vector2 LocalScale","0":"이미지 크기입니다."}]

[{"index":"string MaterialId (Sync)","0":"렌더러에 적용할 머티리얼의 Id를 지정합니다."}]

[{"index":"int32 OrderInLayer (Sync)","0":"같은 Layer 내의 우선순위를 결정합니다. 수가 클수록 앞에 보입니다."}]

[{"index":"boolean OverrideSorting (Sync) (ReadOnly)","0":"SortingLayer 및 OrderInLayer 값을 임의로 설정할지 여부를 결정합니다."}]

[{"index":"float PlayRate","0":"애니메이션 재생 속도입니다."}]

[{"index":"PreserveSpriteType PreserveSprite","0":"원본 이미지의 비율\/피봇\/크기 등을 어떻게 보존하는지에 대한 타입을 정의합니다."}]

[{"index":"string SortingLayer (Sync)","0":"2개 이상의 엔티티가 겹쳤을 때 Sorting Layer에 따라 보이는 우선순위가 결정됩니다."}]

[{"index":"int32 StartFrameIndex","0":"애니메이션 출력 시 시작 프레임 번호입니다."}]

##### inherited from ImageComponent:

[{"index":"Color Color","0":"이미지의 기본 색상을 설정합니다"}]

[{"index":"boolean DropShadow","0":"이미지의 그림자 출력 여부를 설정합니다."}]

[{"index":"float DropShadowAngle","0":"그림자를 출력할 각도를 설정합니다"}]

[{"index":"Color DropShadowColor","0":"그림자 색상을 설정합니다."}]

[{"index":"float DropShadowDistance","0":"이미지와 그림자의 거리입니다."}]

[{"index":"float FillAmount","0":"Type이 Filled로 설정되어 있을 때 표시되는 이미지의 비율입니다. 0부터 1 사이의 값을 사용합니다."}]

[{"index":"boolean FillCenter","0":"Type이 Sliced 또는 Tiled로 설정되어 있을 때 이미지 영역의 가운데를 채울지를 설정합니다."}]

[{"index":"boolean FillClockWise","0":"FillMethod가 Radial90, Radial180, Radial360으로 설정되어 있을 때 채우기 방향을 설정합니다. 값이 true면 시계 방향으로 채워집니다."}]

[{"index":"FillMethodType FillMethod","0":"Type이 Filled일 때의 채우기 방식을 설정합니다."}]

[{"index":"int32 FillOrigin","0":"Type이 Filled로 설정되어 있을 때 채우기 시작점을 설정합니다. FillMethod가 Horizontal 또는 Vertical일 경우 0 ~ 1 값을 사용할 수 있습니다. Radial90, Radial180, Radial360일 경우 0 ~ 3 값을 사용할 수 있습니다."}]

[{"index":"boolean FlipX","0":"이미지의 X축을 기준으로 반전 여부를 결정합니다."}]

[{"index":"boolean FlipY","0":"이미지의 Y축을 기준으로 반전 여부를 결정합니다."}]

[{"index":"int32 FrameColumn (Deprecated)","0":"더는 사용하지 않는 프로퍼티입니다. AnimationClip Editor를 사용하세요."}]

[{"index":"int32 FrameRate (Deprecated)","0":"더는 사용하지 않는 프로퍼티입니다. AnimationClip Editor를 사용하세요."}]

[{"index":"int32 FrameRow (Deprecated)","0":"더는 사용하지 않는 프로퍼티입니다. AnimationClip Editor를 사용하세요."}]

[{"index":"DataRef ImageRUID","0":"화면에 표시될 이미지 RUID입니다."}]

[{"index":"boolean Outline","0":"이미지 외곽선 출력 여부를 설정합니다."}]

[{"index":"Color OutlineColor","0":"이미지 외곽선 색상입니다."}]

[{"index":"float OutlineWidth","0":"외곽선 두께입니다."}]

[{"index":"boolean RaycastTarget","0":"true로 설정할 경우 화면 터치 또는 마우스 클릭 대상이 되며, 뒤에 가려진 UI는 화면 터치와 마우스 클릭 입력을 받지 못합니다."}]

[{"index":"ImageType Type","0":"이미지를 표시하는 방식입니다."}]

##### inherited from Component:

[{"index":"boolean Enable (Sync)","0":"컴포넌트 활성화 여부를 확인합니다."}]

[{"index":"boolean EnableInHierarchy (ReadOnly) (HideFromInspector)","0":"계층 구조상에서 이 컴포넌트가 Enable 상태인지를 반환합니다. Enable이 true일지라도 엔티티의 Enable이 false라면 false를 반환합니다."}]

[{"index":"Entity Entity (ReadOnly)","0":"이 컴포넌트를 소유한 엔티티입니다."}]

# Methods

[{"index":"void ChangeMaterial(string materialId)","0":"렌더러에 적용할 머티리얼을 교체합니다."}]

[{"index":"void SetAlpha(float alpha)","0":"스프라이트의 알파 값을 설정합니다."}]

##### inherited from ImageComponent:

[{"index":"void SetNativeSize()","0":"이미지를 원본 크기로 조정합니다."}]

##### inherited from Component:

[{"index":"boolean IsClient()","0":"현재 실행 환경이 클라이언트인지 아닌지의 여부를 반환합니다."}]

[{"index":"boolean IsServer()","0":"현재 실행 환경이 서버인지 아닌지의 여부를 반환합니다."}]

# Events

[{"index":"OrderInLayerChangedEvent","0":"Component의 OrderInLayer가 변경되었을 때 발생하는 이벤트입니다."}]

[{"index":"SortingLayerChangedEvent","0":"컴포넌트의 SortingLayer가 변경되었을 때 발생하는 이벤트입니다."}]

[{"index":"SpriteGUIAnimPlayerChangeFrameEvent","0":"스프라이트 애니메이션의 프레임이 바뀔 때 발생하는 이벤트입니다."}]

[{"index":"SpriteGUIAnimPlayerEndEvent","0":"스프라이트 애니메이션 재생이 끝날 때 발생하는 이벤트입니다."}]

[{"index":"SpriteGUIAnimPlayerEndFrameEvent","0":"지정한 값으로 SpriteAnimPlayerEndEvent를 초기화합니다."}]

[{"index":"SpriteGUIAnimPlayerStartEvent","0":"스프라이트 애니메이션 재생이 시작될 때 발생하는 이벤트입니다."}]

[{"index":"SpriteGUIAnimPlayerStartFrameEvent","0":"스프라이트 애니메이션이 첫번째 프레임을 재생할 때 발생하는 이벤트입니다."}]

# Examples

스프라이트 애니메이션과 `Fill`을 제어하는 예제입니다.  
`SpriteGUIRendererComponent`가 있는 엔티티에 추가해 테스트할 수 있습니다.
    
    
    @Component
    script CircularProgressAnimator extends Component
        property number Fill = 0
        property boolean IsRequire = false
    
        @ExecSpace("ClientOnly")
        method void OnBeginPlay()
        local renderer = self.Entity.SpriteGUIRendererComponent
        if not renderer then
        	return
        end
    
        self.IsRequire = true
        renderer.ImageRUID = "000000"
        renderer.Type = ImageType.Filled
        renderer.FillMethod = FillMethodType.Radial360
        renderer.Color = Color.white
        renderer.AnimClipPlayType = SpriteAnimClipPlayType.ZigzagLoop
        end
    
        @ExecSpace("ClientOnly")
        method void OnUpdate(number delta)
        if not self.IsRequire then
        	return
        end
    
        self.Fill = math.min( self.Fill + delta, 1)
    
        self.Entity.SpriteGUIRendererComponent.FillAmount = self.Fill
        if self.Fill >= 1.0 then
        	self.Fill = 0
        end
        end
    end
    

# SeeAlso

  * FillMethodType
  * ImageType
  * SpriteAnimClipPlayType
  * math
  * Color
  * [기본 UI 컴포넌트](/docs?postId=744)
  * [UI 제작하기](/docs?postId=64)