Button

Button

클라이언트에서 사용되는 Widget Button 객체.

이벤트

OnPressEvent

버튼이 눌릴 때 호출되는 이벤트에요. 연결함수 형식은 function(pressButton), pressButton 는 눌린 위젯버튼 객체 입니다.

-- 샘플 --

local button = Workspace.ScreenUI.Button

local function PressEvent(self) --OnPressEvent로 연결된 함수는 self 인자가 고정적으로 들어가요.
    print(self.Name .. " Button Click!")
end
button.OnPressEvent:Connect(PressEvent) --버튼에 해당 버튼이 눌렸을때 호출되는 함수를 연결해요.

OnUpEvent

버튼이 눌렸다가 떼어질 때 호출되는 이벤트에요. 연결함수 형식은 function(upButton), upButton 는 눌렸다가 떼어진 위젯버튼 객체 입니다.

-- 샘플 --

local button = Workspace.ScreenUI.Button

local function UpEvent(self) --OnUpEvent로 연결된 함수는 self 인자가 고정적으로 들어가요.
    print(self.Name .. " Button Click!")
end
button.OnUpEvent:Connect(UpEvent) --버튼에 해당 버튼이 눌렸다가 떼어질 때 호출되는 함수를 연결해요.

속성

ImageDrawType

버튼 이미지의 DrawType을 설정하고 얻을 수 있어요 (None, Tile, Slice, Border).

-- 샘플 --

local button = Workspace.ScreenUI.Button

button.ImageDrawType = Enum.ImageDrawType.Image

ImageSliceLeftRight

버튼 이미지의 DrawType이 Slice, Border일 때의 Slice 좌우영역(각각 0부터 1사이)을 정하고 얻을 수 있어요(Left, Right).

-- 샘플 --

local button = Workspace.ScreenUI.Button

button.ImageDrawType = Enum.ImageDrawType.Slice
button.SliceLeftRight = Vector.new(0.5, 0.5, 0) --X : 좌 / Y : 우

ImageSliceTopBottm

버튼 이미지의 DrawType이 Slice, Border일 때의 Slice 좌우영역(각각 0부터 1사이)을 정하고 얻을 수 있어요(Top, Bottom).

-- 샘플 --

local button = Workspace.ScreenUI.Button

button.ImageDrawType = Enum.ImageDrawType.Slice
button.SliceTopBottom = Vector.new(0.5, 0.5, 0) --X : 상 / Y : 하

ImageTiling

버튼 이미지의 DrawType이 Tile일 때의 옵션값을 설정하고 얻을 수 있어요 (NoTile, Horizontal, Vertical, Both)

-- 샘플 --

local button = Workspace.ScreenUI.Button

button.ImageDrawType = Enum.ImageDrawType.Image
button.ImageTiling = Enum.ImageTilingType.Both

함수

void SetText(number Value)

(X.0 , X) 값은 모두 X로 반환되서 출력됩니다. X.0을 출력하고 싶으면 tostring으로 변환후 이용해주세요 위젯의 텍스트를 주어진 실수로 변경해요. ( 변경할 실수 값)

void SetText(string InText)

위젯의 텍스트를 주어진 문자열로 변경해요. (변경할 문자열)

-- 샘플 --

local button = Workspace.ScreenUI.Button
button:SetText("Hello World!")

string GetText()

위젯에 설정된 텍스트를 얻을 수 있어요.

-- 샘플 --

local button = Workspace.ScreenUI.Button
print(button:GetText())

void SetTextColor(Color color)

텍스트의 색을 설정할 수 있어요. (변경할 Color 값)

-- 샘플 --

local button = Workspace.ScreenUI.Button
button:SetTextColor(Color.new(0, 255, 0, 255))

Color GetTextColor()

텍스트의 색을 가져올 수 있어요.

-- 샘플 --

local button = Workspace.ScreenUI.Button
print(button:GetTextColor())

void SetBackgroundColor(Color color)

버튼 위젯의 배경 색을 설정할 수 있어요. (변경할 색)

-- 샘플 --

local button = Workspace.ScreenUI.Button
button:SetBackgroundColor(Color.new(0, 255, 0, 255))

Color GetBackgroundColor()

버튼 위젯의 배경 색을 얻어올 수 있어요.

-- 샘플 --

local button = Workspace.ScreenUI.Button
print(button:GetBackgroundColor())

void SetButtonHoverColor(Color color)

버튼 위젯의 Hover 색을 설정할 수 있어요. (변경할 색)

-- 샘플 --

local button = Workspace.ScreenUI.Button
button:SetButtonHoverColor(Color.new(0, 255, 0, 255))

Color GetButtonHoverColor()

버튼 위젯의 Hover 색을 가져올 수 있어요.

-- 샘플 --

local button = Workspace.ScreenUI.Button
print(button:GetButtonHoverColor())

void SetButtonPressColor(Color color)

버튼 위젯의 Press 색을 설정할 수 있어요. (변경할 색)

-- 샘플 --

local button = Workspace.ScreenUI.Button
button:SetButtonPressColor(Color.new(0, 255, 0, 255))

Color GetButtonPressColor()

버튼 위젯의 Press 색을 가져올 수 있어요.

-- 샘플 --

local button = Workspace.ScreenUI.Button
print(button:GetButtonPressColor())

사용 가능한 부모 오브젝트 기능들

속성

이름	설명
Location	위젯의 위치를 변경할 수 있어요. (X좌표 값, Y좌표 값, 0)
Rotation	위젯의 회전을 설정할 수 있어요. (설정할 값)
Scale	위젯의 스케일을 설정할 수 있어요. (설정할 값)
Size	위젯의 크기를 설정할 수 있어요. (가로값, 세로값, 0)
ZOrder	위젯의 그리는 순서를 설정할 수 있어요.
Visible	UI 위젯의 표시 여부를 설정할 수 있어요. (위젯 표시 여부)
Interaction	UI 위젯의 반응 여부를 설정할 수 있어요. (위젯 반응 여부)
Opacity	위젯의 투명 값을 설정할 수 있어요. (설정할 값)
AnchorType	위젯의 고정 여부를 설정할 수 있어요. (설정할 타입)
IsFill	위젯의 채우기를 설정할 수 있어요.

이벤트

이름	설명
OnVisibleEvent	widget이 보여질 때 호출되는 이벤트에요. 연결함수 형식은 function(widget), widget 은 보여지는 widget 객체 입니다.
OnInVisibleEvent	widget이 안 보여질 때 호출되는 이벤트에요. 연결함수 형식은 function(widget), widget 은 안 보여지는 widget 객체 입니다.
OnBeginDragEvent	widget의 드래그가 시작 될 때 호출되는 이벤트에요. 연결함수 형식은 function(widget, vector2D), widget은 클릭한 객체, vector2D는 마우스 위치에요.
OnCancelDragEvent	widget의 드래그가 취소될 때 호출되는 이벤트에요. 연결함수 형식은 function(widget, vector2D), widget은 클릭한 객체, vector2D는 마우스 위치에요.
OnEndDragEvent	widget의 드래그가 드랍될 때 호출되는 이벤트에요. 연결함수 형식은 function(widget, vector2D, dragwidget), widget은 드랍한 객체, vector2D는 마우스 위치, dragwidget는 드래그한 widget에요.

함수

이름	설명
AddChildUIScene	(deprecate) AddChildUIWidget 함수로 이용하세요.
AddChildWidget	자식 UI 위젯을 추가할 수 있어요. (자식으로 추가할 UI 위젯)
SetParentWidget	부모 UI 위젯을 설정할 수 있어요. (부모로 설정할 UI 위젯)
Delete	위젯을 제거할 수 있어요.
GetTypeString	위젯의 타입을 문자열로 얻을 수 있어요.
GetType	위젯의 타입을 Enum 형식으로 얻을 수 있어요.
SetDragWidget	위젯의 DragEvent 발생 시 복사되어 보여질 widget을 세팅해요.
SetDragOffset	위젯의 DragWidget에 적용될 Offset 이에요.