Methods
소개
Map에 타일 효과나 오브젝트 설치 등 맵과 관련된 편리한 기능을 제공하는 함수들 입니다.
putTileEffect
지정한 좌표에 타일 효과를 적용하는 함수입니다
putObject
지정한 좌표에 오브젝트를 놓는 함수입니다.
putObjectMultiple
오브젝트를 배치할 좌표들을 2차원 배열로 입력하여 한 번에 오브젝트를 설치하는 기능입니다.
putObjectWithKey
지정한 좌표에 키 값을 가진 오브젝트를 놓는 함수입니다.
getObjectWithKey
해당 키 값을 가지고 있는 오브젝트의 정보를 가져옵니다.
playObjectAnimation
해당 좌표에 있는 오브젝트의 스프라이트 애니메이션을 실행시키는 함수입니다.
playObjectAnimationWithKey
key 값이 일치하는 오브젝트의 스프라이트 애니메이션을 실행시키는 함수입니다.
moveObject
x, y 좌표에 위치한 오브젝트를 지정한 x, y 좌표로 time 초 동안 움직이는 함수입니다.
moveObjectWithKey
키 값을 가진 오브젝트를 지정한 x,y 좌표로 움직이는 함수입니다.
clearAllObjects
ZEP 스크립트로 생성된 모든 오브젝트를 제거하는 함수입니다.
getTile
해당하는 레이어의 x,y 좌표에 있는 타일의 enum 값을 반환하는 함수입니다.
hasLocation
맵에 해당 로케이션이 있는지 체크하여 true/false를 반환하는 함수입니다.
getObjectsByType
Type에 해당하는 오브젝트들을 반환하는 함수입니다.
getTopObjectsByType
Type에 해당하는 상단 오브젝트들을 반환하는 함수입니다.
sayObjectWithKey
key 값을 가진 오브젝트 위에 말풍선을 표시하는 함수입니다.
getLocation
파라미터로 전달한 로케이션이 존재하는 경우, 로케이션 설치 좌표를 리턴합니다.
getLocationRandom
파라미터로 전달한 로케이션이 2개이상 존재하는 경우, 무작위로 선택하여 해당 로케이션의 설치 좌표를 리턴합니다.
getLocationList
파라미터로 전달된 로케이션 이름과 일치하는 모든 로케이션의 정보를 배열 형태로 반환합니다
📚 API 설명 및 예제
Methods 함수 한 눈에 보기
putTileEffect
지정한 좌표에 타일 효과를 적용하는 함수입니다.
파라미터
TileEffectType에 대한 자세한 설명은 TileEffectType 상세 설명 페이지를 참고해주세요.
x, y
Number
타일 효과를 설치할 x, y 좌표
tileID
TileEffectType
• TileEffectType.NONE : 없음 •TileEffectType.IMPASSABLE : 통과 불가 • TileEffectType.SPAWN : 스폰
• TileEffectType.PORTAL : 포털 • TileEffectType.PRIVATE_AREA : 프라이빗 공간 • TileEffectType.SPOTLIGHT : 스포트라이트 • TileEffectType.EMBED : 웹 링크 • TileEffectType.LOCATION : 지정 영역 • TileEffectType.AMBIENT_SOUND : 배경 음악 • TileEffectType.TILE_EMBED : 웹 임베드 • TileEffectType.WEB_PORTAL : 웹 포털 • TileEffectType.SPACE_PORTAL : 스페이스 포털
예제
IMPASSABLE 타일 효과 설치해보기
putObject
지정한 좌표에 오브젝트를 놓는 함수입니다. ( 기준 좌표: Left Top ) → 기준 좌표란?
ScriptDynamicResource에 대한 이해를 돕는 스프라이트시트 이해하기 문서를 확인해보세요!
null 값을 파라미터로 전달하여 스크립트로 설치한 오브젝트를 삭제 할 수 있습니다.
파라미터
x, y
Number
오브젝트를 놓을 x, y 좌표
dynamicResource
ScriptDynamicResource
App.loadSpritesheet 함수로 로드한 이미지
option
Object
onObjectTouched, onObjectAttacked 와 같은 App EventListener에서 오브젝트를 인식하려면 파라미터 란에 { overlap: true } 입력해야 합니다.
예제
블루맨 오브젝트 생성해보기
putObjectMultiple
오브젝트를 배치할 좌표들을 2차원 배열로 입력하여 한 번에 오브젝트를 설치하는 기능입니다. 이 기능을 사용하면 한 번에 많은 오브젝트를 설치할 경우 부하를 줄이는 효과를 얻을 수 있습니다.
파라미터
tileArray
Array
오브젝트를 배치할 좌표들을 정의할 2차원 배열을 입력할 수 있습니다. (최대 길이 10 제한)
type
PutObjectType
PutObjectType.STROKE
tileArray 배열에 정의된 좌표들을 순서대로 연결하여 경로를 생성한 다음, 생성된 경로 상의 모든 좌표들에 오브젝트를 배치합니다.
dynamicResource
ScriptDynamicResource
App.loadSpritesheet 함수로 로드한 이미지
option
Object
onObjectTouched, onObjectAttacked 와 같은 App EventListener에서 오브젝트를 인식하려면 파라미터 란에 { overlap: true } 입력해야 합니다.
예제
사각형, 원 모양으로 오브젝트 배치하기
![]()

PutObjectType.STROKE
사각형 모양으로 배치
PutObjectType.STROKE
원 모양으로 배치putObjectWithKey
지정한 좌표에 키 값을 가진 오브젝트를 놓는 함수입니다. ( 기준 좌표: Left Top )
dynamicResource 파라미터에 null 입력시 해당 좌표의 오브젝트를 삭제할 수 있습니다.
관련 문서: 오브젝트 npcProperty
파라미터
x, y
Number
오브젝트를 놓을 x, y 좌표
dynamicResource
ScriptDynamicResource
App.loadSpritesheet 함수로 로드한 이미지
옵션 (option)
값을 입력하지 않아도 Default 값이 적용됩니다
key
String
오브젝트의 키 값 (Default: null)
moveSpeed
Number
오브젝트의 이동속도
(Default: 80)
useDirAnim
Boolean
방향을 인지해서 애니메이션을 재생하는 옵션 (Default: false)
impassable
Boolean
오브젝트 통과불가 옵션 (Default: false)
offsetX
Number
오브젝트 이미지의 배치 기준점의 X좌표 (Default: 0)
offsetY
Number
오브젝트 이미지의 배치 기준점의 Y좌표 (Default: 0)
topObject
Boolean
true 로 설정하면 오브젝트가 상단오브젝트로 설치됩니다. (Default: false)
예제
키 값을 가진 블루맨 오브젝트 생성해보기
getObjectWithKey
해당 키 값을 가지고 있는 오브젝트의 정보를 가져옵니다.
파라미터
key
String
정보를 가져올 오브젝트의 key 값
예제
키 값을 가진 오브젝트를 생성하고 관련 데이터를 채팅창에 출력해보기.

playObjectAnimation
해당 좌표에 있는 오브젝트의 스프라이트 애니메이션을 실행시키는 함수입니다.
해당 좌표 지점에 Map.putObject 함수가 선행되어야합니다.
스프라이트 이미지를 처음 들어보신다면 스프라이트시트 이해하기 문서를 확인해보세요!
파라미터
x, y
Number
타일 효과를 적용할 x, y 좌표
name
String
let 변수 = App.loadSpritesheet(...) 스프라이트를 저장한 변수 이름을 다음과 같이 입력해야 합니다. → ‘#’ + 변수.id
loop
number
애니메이션 반복 횟수 ( -1: 계속반복)
예제
춤추는 블루맨 오브젝트 설치해보기


playObjectAnimationWithKey
key 값이 일치하는 오브젝트의 스프라이트 애니메이션을 실행시키는 함수입니다.
Map.putObjectWithKey함수가 선행되어야합니다.
스프라이트 이미지를 처음 들어보신다면 스프라이트시트 이해하기 문서를 확인해보세요!
파라미터
key
String
오브젝트의 키값
animName
String
플레이할 애니메이션의 이름
repeatCount
Number
애니메이션 반복 횟수 ( -1 입력시 무한반복 )
예제
춤추는 블루맨 오브젝트 설치해보기


moveObject
x, y 좌표에 위치한 오브젝트를 targetX, targetY로 time 초 동안 움직이는 함수입니다.
해당 좌표 지점에 Map.putObject 함수가 선행되어야합니다.
스프라이트 이미지를 처음 들어보신다면 스프라이트시트 이해하기 문서를 확인해보세요!
파라미터
x, y
Number
오브젝트가 위치한 x, y 좌표
targetX, targetY
Number
목적지 x, y 좌표
time
Number
목적지까지 걸리는 시간(초)
예제
블루맨 이동시켜보기


moveObjectWithKey
key 값을 가진 오브젝트를 targetX, targetY로 움직이는 함수입니다.
💡 path 파라미터가 true인 경우, 목표 지점이 impassable 타일이거나 도달 할 수 없는 좌표이면 오브젝트가 움직이지 않습니다.
파라미터
key
String
오브젝트의 key 값
targetX, targetY
Number
목적지 x, y 좌표
usePath
Boolean
true일 경우 Impassable 타일을 통과하지 못합니다. false일 경우 Impassable 타일을 무시하고 지나갑니다.
예제
moveObejctWithKey 동작 방식

clearAllObjects()
ZEP 스크립트로 생성된 모든 오브젝트를 제거하는 함수입니다.
파라미터
없음
예제
생성된 모든 오브젝트 삭제하기
getTile
해당하는 레이어의 x, y 좌표에 있는 타일의 타입 값을 리턴, 타일이 없으면 -1을 리턴합니다.
파라미터
layer
Number
레이어에 해당하는 값 0 = Floor (바닥타일), 1 = WALL (벽타일), 2 = TileEffect (타일효과), 3 = Object (오브젝트), 5 = TopObject (상단오브젝트),
x, y
Number
x, y 좌표
예제
맵에 있는 모든 오브젝트의 타입을 조회하기
getLocation
파라미터로 전달한 로케이션이 존재하는 경우, 로케이션 설치 좌표를 리턴합니다.
파라미터
locationName
String
로케이션 이름
예제
맵 에디터에서 타일효과 > 지정 영역 선택 후 영역 이름을 "testLocation" 으로 지정해 맵에 설치한 후 예제 코드를 실행해보세요.
getLocationRandom
파라미터로 전달한 로케이션이 2개이상 존재하는 경우, 무작위로 선택하여 해당 로케이션의 설치 좌표를 리턴합니다.
파라미터
locationName
String
로케이션 이름
예제
맵 에디터에서 타일효과 > 지정 영역 선택 후 영역 이름을 "testLocation" 으로 지정해 맵에 여러개 설치한 후 예제 코드를 실행해보세요.
getLocationList
파라미터로 전달된 로케이션 이름과 일치하는 모든 로케이션의 정보를 배열 형태로 반환합니다. 각각의 로케이션 정보는 로케이션 설치 좌표(x, y), 크기(width, height), 그리고 라벨 값(label)을 포함하고 있습니다.
파라미터
locationName
String
로케이션 이름
예제
맵 에디터에서 타일효과 > 지정 영역 선택 후 영역 이름을 "testLocation" 으로 지정해 맵에 여러개 설치한 후 예제 코드를 실행해보세요.

hasLocation
맵에 해당 로케이션이 있는지 체크하여 true/false 값을 리턴합니다.
파라미터
locationName
String
로케이션 이름
예제
로케이션이 설치되어있는지 체크하는 키 함수 만들어보기
getObjectsByType
Type에 해당하는 오브젝트들을 리턴하는 함수입니다.
파라미터
type
Number
오브젝트의 type 값
예제
모든 타입의 오브젝트 조회하기

getTopObjectsByType
Type에 해당하는 상단오브젝트들을 리턴하는 함수입니다.
파라미터
type
Number
오브젝트의 type 값
예제
모든 타입의 상단오브젝트 조회하기

sayObjectWithKey
key 값을 가진 오브젝트 위에 말풍선을 표시하는 함수입니다.
파라미터
key
String
대상오브젝트의 키 값
message
String
말풍선에 표시할 메시지
예제
key 값을 가진 오브젝트 위에 말풍선 표시하기

부록
Last updated
Was this helpful?