Methods

소개
UI, 유저 컨트롤, 사운드 등 ZEP에서 일어날 수 있는 전반적인 기능을 제공하는 함수입니다.
플레이어 개인 화면에 UI를 표시, 플레이어를 이동, 플레이어 개인에게 사운드 재생 등 편리한 기능을 제공합니다.
UI
이름
설명
showCenterLabel
플레이어에게 지정된 위치에 text를 3초간 표시하는 함수입니다.
showCustomLabel
플레이어에게 지정된 위치에 text를 3초간 표시하는 함수입니다.
text 부분에 span 태그를 넣어 텍스트를 꾸밀 수 있습니다.
showWidget
플레이어에게 지정된 위치에 위젯을 불러오는 함수입니다.
showBuyAlert
플레이어에게 구매 위젯을 표시하고, 구매 후 동작하는 콜백함수를 작성할 수 있습니다.
hideBuyAlert
플레이어의 구매 위젯을 숨깁니다.
sendMessage
유저 개인에게 채팅 메시지를 보냅니다.
showPrompt
플레이어에게 입력창을 보여주고, 플레이어의 응답에 따라 동작하는 callback 함수를 작성할 수 있습니다.
showConfirm
플레이어에게 확인창을 보여주고, 플레이어가 OK를 눌렀을 때 동작하는 콜백함수를 작성할 수 있습니다.
showAlert
플레이어에게 경고창을 보여주고, 플레이어가 OK를 눌렀을 때 동작하는 callback 함수를 작성할 수 있습니다.
showImageModal
플레이어에게 입력한 이미지 주소에 해당하는 이미지를 표시합니다.
showNoteModal
플레이어에게 텍스트 창을 보여주는  함수입니다.
showWidgetResponsive
위젯의 상/하/좌/우 여백을 화면 크기에 대한 %비율로 정의하여 위젯을 표시합니다.
openWebLink
플레이어에게 웹 URL을 새 창이나 팝업 창으로 열어 보여줍니다.
showEmbed
URL을 임베드 형태로 표시합니다. 
크기와  위치를 설정할  수 있습니다.
Data Load
이름
설명
isEmail
플레이어의 이메일을 비교하는 함수입니다.
getLocationName
플레이어가 서있는 지정 영역의 이름을 출력합니다.
User Control
이름
설명
spawnAt
플레이어의 캐릭터를 지정한 좌표로 이동시키는 함수입니다.
spawnAtLocation
플레이어의 캐릭터를 지정 영역으로 이동시키는 함수입니다.
spawnAtMap
플레이어를 다른 스페이스 또는 맵으로 이동시키는 함수입니다.
setCameraTarget
플레이어의 시점을 지정된 좌표로 중심 이동시킵니다.
setCameraTargetWithKey
플레이어의 시점을 특정 오브젝트로 중심 이동시킵니다.
setEffectSprite
플레이어의 배경 또는 전경 이미지를 설정 할 수 있습니다.
Sound
이름
설명
playSound
플레이어에게 사운드 파일을 재생하는 함수입니다.
playSoundLink
플레이어에게 사운드 URL을 재생하는 함수입니다.
공통
이름
설명
sendUpdated
Player 관련 필드 값이 변경되면 변경 값을 적용하는 함수입니다.
save
Player storage 값이 변경되면 변경 값을 적용하는 함수입니다.
​
📚 API 설명 및 예제
🎨 UI Methods
UI 함수 한 눈에 보기
// 플레이어에게 지정된 위치에 해당 text를 3초간 표시
player.showCenterLabel(text: string, color: uint = 0xFFFFFF, bgColor: uint = 0x000000, offset: int = 0, time: int = 3000)
​
// 모든 플레이어에게 지정된 위치에 해당 text를 3초간 표시, 커스터마이징 가능
player.showCustomLabel(text: string, color: number = 0xFFFFFF, bgColor: number = 0x000000, offset: number = 0, width = 100, opacity = 0.6, time: int = 3000);
​
// 플레이어에게 지정된 align의 위치에 해당 html파일을 위젯으로 불러옴
player.showWidget(fileName: string, align: string, width: number, height: number): ScriptWidget
​
// 플레이어에게 구매 위젯을 표시하고, 구매 후 동작하는 콜백함수를 작성할 수 있습니다.
player.showBuyAlert(itemName: string, price: number, callback: function);
​
// 플레이어의 구매 위젯을 닫습니다.
player.hideBuyAlert();
​
// 플레이어 개인에게 채팅 메시지를 보냅니다.
player.sendMessage(message: string, color: number = 0xFFFFFF)
​
// 플레이어에게 입력창을 보여주고, 플레이어의 응답에 따라 동작하는 callback 함수를 작성할 수 있습니다.
player.showPrompt(text: string, function(inputText))
​
// 플레이어에게 확인창을 보여주고, 플레이어가 OK를 눌렀을 때 동작하는 콜백함수를 작성할 수 있습니다.
player.showConfirm(text: string, function(result))
​
// 플레이어에게 경고창을 보여주고, 플레이어가 OK를 눌렀을 때 동작하는 callback 함수를 작성할 수 있습니다.
player.showAlert(text: string, function())
​
// 위젯의 상/하/좌/우 여백을 화면 크기에 대한 % 비율로 정의하여 위젯을 표시합니다.
player.showWidgetResponsive(fileName:string, marginTop:number, marginRight:number, marginBottom:number, marginLeft:number)
​
//플레이어에게 웹 URL을 새 창이나 팝업 창으로 표시합니다.
player.openWebLink(url:string, popup:boolean);
​
// 지정된 align의 위치에 url 임베드창을 표시합니다.
player.showEmbed(url: string, align: string, width: number, height: number, hasBackdrop: boolean = true)
​
showCenterLabel
 player.showCenterLabel(text: string, color: uint = 0xFFFFFF, bgColor: uint = 0x000000, offset: number = 0, time: number = 3000)
해당 플레이어에게 지정된 위치에 text를 3초간 표시하는 함수입니다.
파라미터
이름
타입
설명
text
String
라벨에 출력할 텍스트
color
Uint
출력할 글씨의 색을 지정합니다. (HexCode)
값을 입력하지 않을 경우, 흰색(0xFFFFFF)으로 적용됩니다.
➡️구글 색상 선택 도구​
bgColor
Uint
메시지가 출력되는 라벨의 배경색을 지정합니다.
값을 입력하지 않을 경우, 검은색(0x000000)으로 적용됩니다.
offset
number
offset 값이 클수록 표시되는 위치가 화면 아래쪽 방향으로 가까워집니다.
값을 입력하지 않을 경우, 0으로 지정됩니다.
time
number
라벨 표시 시간 (ms), 기본 값 3000 ( 3초 )
예제
노란색 라벨을 2초간 출력해보기
App.onJoinPlayer.Add(function(player){
	player.showCenterLabel(`${player.name}님 환영합니다.`, 0x000000, 0xFFFF00, 500, 2000); // 노란색 배경, 검정색 글씨로 표시하기
});
​
showCustomLabel
player.showCustomLabel(text: string, color: number = 0xFFFFFF, bgColor: number = 0x000000, offset: number = 0, width = 100, opacity = 0.6, time: number = 3000);
모든 플레이어에게 지정된 위치에 text를 3초간 표시하는 함수입니다.
text 부분에 span 태그를 넣어 텍스트를 꾸밀 수 있습니다.
파라미터
이름
타입
설명
text
String
라벨에 출력할 텍스트 ( span 태그 허용 )
color
Uint
출력할 글씨의 색 (HexCode)
값을 입력하지 않을 경우, 흰색(0xFFFFFF)으로 적용됩니다.
➡️구글 색상 선택 도구​
bgColor
Uint
메시지가 출력되는 라벨의 배경색
값을 입력하지 않을 경우, 검은색(0x000000)으로 적용됩니다.
offset
number
offset 값이 클수록 표시되는 위치가 화면 아래쪽 방향으로 가까워집니다.
값을 입력하지 않을 경우, 0으로 지정됩니다.
width
number
라벨의 너비를 n%로 설정하는 값 입니다. (기본 값 100)
opacity
number
라벨의 배경 투명도를 설정하는 값 입니다. (기본 값 0.6, 범위 0 ~ 1)
time
number
라벨 표시 시간 (ms), 기본 값 3000 ( 3초 )
예제
HTML 태그를 넣어 라벨 꾸며보기
// x를 눌렀을때 동작하는 함수
App.addOnKeyDown(88, function (player) {
  // x 를 넣을 흰색 박스 스타일
	let style =
		"display: inline-block; text-align: center; width:1.2em; height:1.2em; line-height: 1.2em; color: black; background-color: white; font-size: 1.2em; border-radius:3px";
	player.showCustomLabel(
		`<span style="${style}">X</span>  버튼을 눌러 예제를 실행할 수 있습니다`,
		0xffffff, // 흰색글씨
		0, // 검은색 배경
		300, // 오프셋 300
		20, // 너비 20%
		1, // 투명도 1 -> 불투명
		5000 // 표시 시간 5000 -> 5초간 표시
	);
});
​
showWidget
player.showWidget(fileName: string, align: string, width: number, height: number): ScriptWidget
해당 플레이어에게 지정된 align의 위치에 해당 html파일을 위젯으로 불러오는 함수입니다.
파라미터
이름
타입
설명
fileName
String
불러올 파일의 이름
align
String
위젯을 표시할 위치
’popup’, ‘sidebar’, ‘top’, ‘topleft’, ‘topright’, ‘middle’, ‘middleleft’, ‘middleright’, ‘bottom’, ‘bottomleft’, ‘bottomright’
width
height
number
위젯을 표시할 영역의 가로, 세로 크기(px)
예제
초성퀴즈 위젯 따라해보기
예제_showWidget(player).zip
1KB
Binary
let _widget = null;
// 플레이어가 입장할 때 실행
App.onJoinPlayer.Add(function (player) {
	_widget = player.showWidget("widget.html", "top", 200, 300); // 화면 상단, 200x300 영역에 위젯을 보여줌
	_widget.sendMessage({
		timer: 15,
		answer: "ㅅㅍㅋ",
	});
});
​
​
showBuyAlert
player.showBuyAlert(itemName: string, price: number, callback: function, payToSpaceOwner: Boolean, option: object)
플레이어에게 구매 위젯을 표시하고, 구매 후 동작하는 콜백함수를 작성할 수 있습니다.
소모된 ZEM은 앱 제작자에게 돌아가며, 내 후원 내역 페이지에서 내역을 확인 할 수 있습니다.
ZEM 정산 관련 내용은 정산가이드 페이지에서 확인하실 수 있습니다.
파라미터
이름
타입
설명
itemName
String
구매창에 표시할 아이템의 이름
price
number
아이템의 가격 (화폐단위: ZEM)
callback
function
구매 성공시 동작할 콜백함수
구매 성공 여부(success)와 구매정보(buyAlertResult) 데이터를 전달 받으며, buyAlertResult는 환불 기능에 사용됩니다.
payToSpaceOwner
Boolean
기본 값은 false로 설정되며
false인 경우 앱 소유자에게 수익이 전달되고,
true인 경우 맵 소유자에게 수익이 전달됩니다.
option
Object
다음 옵션들을 설정 할 수 있습니다.
message : 구매창에 표시할 텍스트를 설정 할 수 있습니다.
timer : 구매창을 표시할 시간(ms)을 설정할 수 있습니다.
예제 
구매정보 저장 및 환불 기능 예제
const itemName = "ITEM";
​
// Q를 누르면 동작하는 함수 - 아이템을 구매하고 player.storage에 구매정보 저장하기
App.addOnKeyDown(81, function (player) {
	let pStorage = JSON.parse(player.storage);
	if (!player.tag) {
		player.tag = {};
	}
	if (pStorage == null) {
		pStorage = {};
	}
	//이미 아이템을 구매했다면 메시지 출력
	if (pStorage[itemName]) {
		player.showCenterLabel(`${itemName}을 이미 구매했습니다.`);
	} else {
		player.showBuyAlert(itemName, 0, function (success, buyAlertResult) {
			if (success) {
				App.sayToAll(`[정보] ${player.name}님이 ${itemName}을 구매했습니다!`);
				pStorage[itemName] = true;
				player.tag.buyAlertResult = buyAlertResult
				player.storage = JSON.stringify(pStorage);
				player.save();
			}
		}, 
		false,// false 인 경우 앱 소유자에게 수익전달, true이면 스페이스 소유자에게 수익 전달
		{
			message: `${itemName} custom message`,//message에 itemName에 해당하는 text가 있을 경우 강조되어 표시됨
			timer: 10000 // 10초 - 구매창 표시시간(ms)
		}
		);
	}
});
​
// W를 누르면 동작하는 함수 - 환불 기능
App.addOnKeyDown(87, function (player) {
	let pStorage = JSON.parse(player.storage);
	if( pStorage && player.tag.buyAlertResult )
	{	
		if( player.tag.buyAlertResult.Refund() )
		{
			App.sayToAll("===== refund success!");
			pStorage[itemName] = false;
		}
		else {
			App.sayToAll("===== refund failed");
		}
		player.tag.buyAlertResult = null;
		player.storage = JSON.stringify(pStorage);
		player.save();
	}
})
구매위젯 예시
timer와 message 옵션을 설정한 경우
​
hideBuyAlert
player.hideBuyAlert()
플레이어의 구매 위젯을 닫습니다.
파라미터 
없음
​
sendMessage
 player.sendMessage(text: string, color: uint = 0xFFFFFF)
유저 개인에게 채팅 메시지를 보내는 함수입니다.
파라미터
이름
타입
설명
text
String
라벨에 출력할 텍스트
color
Uint
출력할 글씨의 색을 지정합니다. (HexCode)
값을 입력하지 않을 경우, 흰색(0xFFFFFF)으로 적용됩니다.
➡️구글 색상 선택 도구​
예제
플레이어 개인에게만 보이는 환영메시지 출력하기.
​
App.onJoinPlayer.Add(function(player){
    player.sendMessage(`${player.name}님 어서오세요!\nhttps://docs-kr.zep.us/ 링크 클릭시 가이드로 연결됩니다.`,0xffffff);
});
​
​
showPrompt
 player.showPrompt(title: string, function(inputText), option = {})
플레이어에게 입력창을 보여주고, 플레이어의 응답에 따라 동작하는 callback 함수를 작성할 수 있습니다.
파라미터
이름
타입
설명
title
String
입력창의 타이틀
inputText
String
플레이어가 입력한 텍스트
옵션
값을 입력하지 않아도 default 값이 적용됩니다.
이름
타입
설명
content
String
입력창 위에 출력할 텍스트 (Default: null)
confrimVariant
'primary' | 'alert'
confirm 버튼의 색상 (Default: "primary")
- 'primary': 푸른색,
- 'alert': 붉은색 
cancelText
String
cancel 버튼의 텍스트 (Default: "취소")
confirmText
String
confirm 버튼의 텍스트 (Default: "확인")
placeholder
String
input placeholder 텍스트 (Default: null)
textType
'text' | 'password'
입력 타입 (Default: "text")
- 'text': 입력 값을 텍스트로 표시
- 'password': 입력 값을 *로 표시
예제
"1234"를 입력하는 경우 "Correct" 메시지 출력해보기
​
​
​
// Q키를 누르면 동작하는 함수
App.addOnKeyDown(KeyCodeType.q, function (player) {
    player.showPrompt("Password", function (inputText) {
            if (inputText == "1234") {
                player.showCenterLabel("Correct");
            } else {
                player.showCenterLabel("Incorrect");
            }
        },
        {
            content: 'Description', // 설명
            confirmVariant: 'primary', // 확인 버튼 색상 'primary' | 'alert'
            cancelText: 'custom cancel', // 취소 버튼 텍스트
            confirmText: 'custom confirm',// 확인 버튼 텍스트
            placeholder: 'Custom Placeholder',// 입력칸의 placeholder
            textType: 'password' // 입력 텍스트의 표시 형식 'text' | 'password'
        }
    );
});
​
showConfirm
 player.showConfirm(text: string, function(result), option = {})
플레이어에게 확인창을 보여주고, 플레이어가 확인 버튼을 눌렀을 때 동작하는 callback 함수를 작성할 수 있습니다. cancel을 누를 경우에는 callback 함수가 동작하지 않습니다.
파라미터
이름
타입
설명
text
String
확인창에 출력할 텍스트
result
Boolean
플레이어가 OK를 누르는 경우 true
옵션
값을 입력하지 않아도 default 값이 적용됩니다.
이름
타입
설명
content
String
입력창 위에 출력할 텍스트 (Default: null)
confrimVariant
'primary' | 'alert'
confirm 버튼의 색상 (Default: 'primary')
- primary: 푸른색,
- alert: 붉은색
cancelText
String
cancel 버튼의 텍스트 (Default: "취소")
confirmText
String
confirm 버튼의 텍스트 (Default: "확인")
​
예제
확인 버튼을 누른 경우 채팅창에 텍스트 출력하기
​
​
​
// Q 키를 누르면 동작하는 함수
App.addOnKeyDown(KeyCodeType.q, function (player) {
    player.showConfirm("Confirm", function (result) {
            if (result) {
                App.sayToAll("ok");
            }
        },
        {
            content: 'Description', // 설명
            confirmVariant: 'alert', // 확인 버튼 색상 'primary' | 'alert';
            cancelText: 'custom cancel', // 취소 버튼 텍스트
            confirmText: 'custom confirm',// 확인 버튼 텍스트
        }
    );
});
​
showAlert
 player.showAlert(text: string, function(), option = {})
플레이어에게 경고창을 보여주고, 플레이어가 OK를 눌렀을 때 동작하는 callback 함수를 작성할 수 있습니다.
파라미터
이름
타입
설명
text
String
경고창에 출력할 텍스트
옵션
값을 입력하지 않아도 default 값이 적용됩니다.
이름
타입
설명
content
String
입력창 위에 출력할 텍스트 (Default: null)
confirmText
String
confirm 버튼의 텍스트 (Default: "확인")
​
예제
버튼을 누른 경우 채팅창에 텍스트 출력하기
​
​
// Q 키를 누르면 동작하는 함수
App.addOnKeyDown(81, function (player) {
    player.showAlert("Alert", function () {
            App.sayToAll("ok");
        },
        {
            content: 'Description', // 설명
            confirmText: 'custom confirm',// 확인 버튼 텍스트
        }
    );
});
​
showWidgetResponsive
player.showWidgetResponsive(fileName:string, marginTop:number, marginRight:number, marginBottom:number, marginLeft:number)
위젯의 상/하/좌/우 여백을 화면 크기에 대한 %비율로 정의하여 위젯을 표시합니다.
화면의 크기가 여백을 포함한 위젯 영역보다 작아질 경우, 위젯의 크기가 비례하여 작아집니다.
파라미터
이름
타입
설명
fileName
String
불러올 파일의 이름
margin top/left/right/bottom
String
상/하/좌/우 여백의 % 값
예제
화면 크기를 줄이는 경우 위젯의 크기 변화
showWidgetResponsive.zip
16KB
Binary
App.onJoinPlayer.Add(function (player) {
	player.tag = {};
});
​
// Q 키를 누르면 동작하는 함수
App.addOnKeyDown(81, function (player) {
	player.tag.widget = player.showWidgetResponsive("result.html", 15, 15, 15, 15);
	player.tag.widget.onMessage.Add(function (player, data) {
		if (data.type == "close") {
			player.tag.widget.destroy();
			player.tag.widget = null;
		}
	});
});
​
openWebLink
player.openWebLink(url:string, popup:boolean=false)
플레이어에게 웹 URL을 새 창이나 팝업 창으로 표시합니다.
파라미터
이름
타입
설명
url
String
연결할 웹 url 주소
popup
boolean
true 인 경우, url 창을 팝업 형태로 표시합니다.
예제
openWebLink 팝업으로 여는 경우
// Q 키를 누르면 동작하는 함수
App.addOnKeyDown(81, function (player) {
	player.openWebLink("https://docs-kr.zep.us", true);
});
팝업으로 url 창을 표시
​
showEmbed
player.showEmbed(url: string, align: string, width: number, height: number, hasBackdrop: boolean = true)
해당 플레이어에게 지정된 align의 위치에 url 임베드  화면을 표시하는 함수입니다.
파라미터
이름
타입
설명
url
String
웹 url 주소
align
String
임베드를 표시할 위치
‘sidebar’, ‘top’, ‘topleft’, ‘topright’, ‘middle’, ‘middleleft’, ‘middleright’, ‘bottom’, ‘bottomleft’, ‘bottomright’
width
height
number
임베드 영역의 가로, 세로 크기(px)
hasBackdrop
boolean
true일 경우 임베드의 바깥 배경에 그림자를 표시합니다.
예제
url 임베드창 표시하기
​
​
​
// Q
App.addOnKeyDown(81, function (player) {
	player.showEmbed("https://youtu.be/ztuTrpXJyks", "middle", 900, 600, true);
});
​
showImageModal
player.showImage(url: string)
플레이어에게 입력한 이미지 주소에 해당하는 이미지를 표시합니다.
파라미터
이름
타입
설명
url
String
표시할이미지 url
예제
이미지 모달창 표시하기
// Q를 누르면 동작하는 함수
App.addOnKeyDown(KeyCodeType.Q, function (player) {
    player.showImageModal("https://cdn-static.zep.us/static/images/thumbnail.png");
});
​
showNoteModal
player.showNoteModal(text: string)
플레이어에게 텍스트 창을 보여주는  함수입니다.
파라미터
이름
타입
설명
text
String
표시할 텍스트
예제
텍스트 창 표시하기
​
​
// Q를 누르면 동작하는 함수
App.addOnKeyDown(KeyCodeType.Q, function (player) {
    player.showNoteModal("Lorem ipsum dolor sit amet consectetur adipisicing elit. Voluptatibus autem nisi soluta commodi a eius distinctio facilis est ea ullam. Dolorum a quis, impedit nisi voluptates magni architecto odit amet.");
});
​
​
💻 Data Load Methods
Data Load Methods 함수 한 눈에 보기
// 지정한 이메일과 플레이어의 이메일을 비교
player.isEmail(email: string): boolean
​
// 플레이어가 서있는 구역이름을 호출
player.getLocationName(): string
isEmail
player.isEmail(email: string): boolean
해당 플레이어의 이메일이 파라미터 값과 같다면 true, 아니면 false를 리턴합니다.
파라미터
이름
타입
설명
email
String
비교할 이메일 텍스트
예제
플레이어의 이메일이 지정한 텍스트와 같은지 비교해보기
// q 키를 누르면 동작하는 함수
// App.addOnKeyDown
	let check = player.isEmail("[email protected]");
	App.sayToAll(`이메일 일치 여부: ${check}`)
})
​
getLocationName
player.getLocationName : string
플레이어가 서있는 지정 영역의 이름을 출력합니다.
지정 영역은 ‘맵에디터 > 타일효과’ 에서 설정 할 수 있습니다.
파라미터
없음
예제
캐릭터가 서있는 타일의 영역이름 출력해보기
→ 지정 영역 설정이 안되있다면 공백으로 출력됩니다
// q 키를 누르면 동작하는 함수
// App.addOnKeyDown
App.addOnKeyDown(81,function(player){
	App.sayToAll

이름	설명
showCenterLabel	플레이어에게 지정된 위치에 text를 3초간 표시하는 함수입니다.
showCustomLabel	플레이어에게 지정된 위치에 text를 3초간 표시하는 함수입니다. text 부분에 span 태그를 넣어 텍스트를 꾸밀 수 있습니다.
showWidget	플레이어에게 지정된 위치에 위젯을 불러오는 함수입니다.
showBuyAlert	플레이어에게 구매 위젯을 표시하고, 구매 후 동작하는 콜백함수를 작성할 수 있습니다.
hideBuyAlert	플레이어의 구매 위젯을 숨깁니다.
sendMessage	유저 개인에게 채팅 메시지를 보냅니다.
showPrompt	플레이어에게 입력창을 보여주고, 플레이어의 응답에 따라 동작하는 callback 함수를 작성할 수 있습니다.
showConfirm	플레이어에게 확인창을 보여주고, 플레이어가 OK를 눌렀을 때 동작하는 콜백함수를 작성할 수 있습니다.
showAlert	플레이어에게 경고창을 보여주고, 플레이어가 OK를 눌렀을 때 동작하는 callback 함수를 작성할 수 있습니다.
showImageModal	플레이어에게 입력한 이미지 주소에 해당하는 이미지를 표시합니다.
showNoteModal	플레이어에게 텍스트 창을 보여주는 함수입니다.
showWidgetResponsive	위젯의 상/하/좌/우 여백을 화면 크기에 대한 %비율로 정의하여 위젯을 표시합니다.
openWebLink	플레이어에게 웹 URL을 새 창이나 팝업 창으로 열어 보여줍니다.
showEmbed	URL을 임베드 형태로 표시합니다. 크기와 위치를 설정할 수 있습니다.

이름	설명
isEmail	플레이어의 이메일을 비교하는 함수입니다.
getLocationName	플레이어가 서있는 지정 영역의 이름을 출력합니다.

이름	설명
spawnAt	플레이어의 캐릭터를 지정한 좌표로 이동시키는 함수입니다.
spawnAtLocation	플레이어의 캐릭터를 지정 영역으로 이동시키는 함수입니다.
spawnAtMap	플레이어를 다른 스페이스 또는 맵으로 이동시키는 함수입니다.
setCameraTarget	플레이어의 시점을 지정된 좌표로 중심 이동시킵니다.
setCameraTargetWithKey	플레이어의 시점을 특정 오브젝트로 중심 이동시킵니다.
setEffectSprite	플레이어의 배경 또는 전경 이미지를 설정 할 수 있습니다.

이름	설명
playSound	플레이어에게 사운드 파일을 재생하는 함수입니다.
playSoundLink	플레이어에게 사운드 URL을 재생하는 함수입니다.

이름	설명
sendUpdated	Player 관련 필드 값이 변경되면 변경 값을 적용하는 함수입니다.
save	Player storage 값이 변경되면 변경 값을 적용하는 함수입니다.

이름	타입	설명
text	String	라벨에 출력할 텍스트
color	Uint	출력할 글씨의 색을 지정합니다. (HexCode) 값을 입력하지 않을 경우, 흰색(0xFFFFFF)으로 적용됩니다. ➡️구글 색상 선택 도구
bgColor	Uint	메시지가 출력되는 라벨의 배경색을 지정합니다. 값을 입력하지 않을 경우, 검은색(0x000000)으로 적용됩니다.
offset	number	offset 값이 클수록 표시되는 위치가 화면 아래쪽 방향으로 가까워집니다. 값을 입력하지 않을 경우, 0으로 지정됩니다.
time	number	라벨 표시 시간 (ms), 기본 값 3000 ( 3초 )

이름	타입	설명
text	String	라벨에 출력할 텍스트 ( span 태그 허용 )
color	Uint	출력할 글씨의 색 (HexCode) 값을 입력하지 않을 경우, 흰색(0xFFFFFF)으로 적용됩니다. ➡️구글 색상 선택 도구
bgColor	Uint	메시지가 출력되는 라벨의 배경색 값을 입력하지 않을 경우, 검은색(0x000000)으로 적용됩니다.
offset	number	offset 값이 클수록 표시되는 위치가 화면 아래쪽 방향으로 가까워집니다. 값을 입력하지 않을 경우, 0으로 지정됩니다.
width	number	라벨의 너비를 n%로 설정하는 값 입니다. (기본 값 100)
opacity	number	라벨의 배경 투명도를 설정하는 값 입니다. (기본 값 0.6, 범위 0 ~ 1)
time	number	라벨 표시 시간 (ms), 기본 값 3000 ( 3초 )

이름	타입	설명
fileName	String	불러올 파일의 이름
align	String	위젯을 표시할 위치 ’popup’, ‘sidebar’, ‘top’, ‘topleft’, ‘topright’, ‘middle’, ‘middleleft’, ‘middleright’, ‘bottom’, ‘bottomleft’, ‘bottomright’
width height	number	위젯을 표시할 영역의 가로, 세로 크기(px)

이름	타입	설명
itemName	String	구매창에 표시할 아이템의 이름
price	number	아이템의 가격 (화폐단위: ZEM)
callback	function	구매 성공시 동작할 콜백함수 구매 성공 여부(`success`)와 구매정보(`buyAlertResult`) 데이터를 전달 받으며, buyAlertResult는 환불 기능에 사용됩니다.
payToSpaceOwner	Boolean	기본 값은 false로 설정되며 false인 경우 앱 소유자에게 수익이 전달되고, true인 경우 맵 소유자에게 수익이 전달됩니다.
option	Object	다음 옵션들을 설정 할 수 있습니다. `message` : 구매창에 표시할 텍스트를 설정 할 수 있습니다. `timer` : 구매창을 표시할 시간(ms)을 설정할 수 있습니다.

이름	타입	설명
title	String	입력창의 타이틀
inputText	String	플레이어가 입력한 텍스트

이름	타입	설명
content	String	입력창 위에 출력할 텍스트 (Default: null)
confrimVariant	'primary' \| 'alert'	confirm 버튼의 색상 (Default: "primary") - 'primary': 푸른색, - 'alert': 붉은색
cancelText	String	cancel 버튼의 텍스트 (Default: "취소")
confirmText	String	confirm 버튼의 텍스트 (Default: "확인")
placeholder	String	input placeholder 텍스트 (Default: null)
textType	'text' \| 'password'	입력 타입 (Default: "text") - 'text': 입력 값을 텍스트로 표시 - 'password': 입력 값을 *로 표시

이름	타입	설명
text	String	확인창에 출력할 텍스트
result	Boolean	플레이어가 OK를 누르는 경우 true

이름	타입	설명
url	String	연결할 웹 url 주소
popup	boolean	true 인 경우, url 창을 팝업 형태로 표시합니다.

이름	타입	설명
url	String	웹 url 주소
align	String	임베드를 표시할 위치 ‘sidebar’, ‘top’, ‘topleft’, ‘topright’, ‘middle’, ‘middleleft’, ‘middleright’, ‘bottom’, ‘bottomleft’, ‘bottomright’
width height	number	임베드 영역의 가로, 세로 크기(px)
hasBackdrop	boolean	true일 경우 임베드의 바깥 배경에 그림자를 표시합니다.

Methods

소개

UI

Data Load

User Control

Sound

공통

📚 API 설명 및 예제

🎨 UI Methods

showCenterLabel

showCustomLabel

​

showWidget

showBuyAlert

hideBuyAlert

sendMessage

​

showPrompt

showConfirm

showAlert

showWidgetResponsive

openWebLink

showEmbed

showImageModal

showNoteModal

💻 Data Load Methods

isEmail

getLocationName