Codes - HonestSquare/UMUX GitHub Wiki
- 본 문서는 API 레벨 5(2.0.0 Busan)를 기반으로 작성한 코드 해설문입니다.
-
Ctrl
+F
를 통해 개별 열람이 가능합니다.
콘솔창 입출력
오직 서버 콘솔창에서만 사용 가능한 메서드가 모여있는 항목입니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | function c(msg : string) |
8(2.2.0)~ | const c(msg : string) |
- 콘솔창에서 방으로 메시지를 입력하는 메서드입니다.
const stopbot()
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 서버 가동을 중단하는 메서드입니다.
- 이 메서드를 사용하는 동안 게임에서 접속이 불가능합니다.
초기화
- 방장 이름입니다. 그대로 두는 것을 권장합니다.
- 기본값은
' '
입니다.
- 공개방 여부입니다.
-
true
는 공개방,false
는 비공개방으로 열립니다. - 기본값은
true
입니다.
방장 표식 여부입니다.
-
true
는 공개,false
는 비공개로 열립니다. -
false
일 경우ChatSystem
클래스의 일부 메서드 사용에 제약을 받게 됩니다. - 기본값은
true
입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 지역 코드입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 서버가 위치할 위도입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 서버가 위치할 경도입니다.
const INITROOM(str : PASSWORD)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 서버를 초기화하는 메서드입니다.
ROOM.setCustomStadium(id : maps)
- 봇방 기본 유즈맵입니다.
- 기본값은
maps[0]
입니다.
ROOM.setScoreLimit(id : ScoresObject)
ROOM.setTimeLimit(id : ScoresObject)
GameManger 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
게임 속 이벤트 제어를 담당하는 클래스입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 6(2.0.1) |
- 공의 좌표를 저장하는 변수입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 서버의 링크를 저장하는 변수입니다.
- 게임이 시작될 때 실행하는 메서드입니다 .
- 게임 진행중에 실행하는 메서드입니다.
- 게임이 종료될 때 실행하는 메서드입니다.
onGamePause(byPlayer : PlayerObject)
- 게임이 중단될 때 실행하는 메서드입니다.
onGameUnpause(byPlayer : PlayerObject)
- 게임 중단 후 다시 진행될 때 실행하는 메서드입니다.
onPlayerJoin(player : PlayerObject)
- 플레이어가 입장할 때 실행하는 메서드입니다.
onPlayerLeave(player : PlayerObject)
- 플레이어가 퇴장할 때 실행하는 메서드입니다.
onStadiumChange(mapName : string)
- 맵이 교체될 때 실행하는 메서드입니다.
onPlayerBallKick(player : PlayerObject)
onTeamGoal(team : TeamID)
- 득/실점 골 판정이 날 때 실행하는 메서드입니다.
onTeamVictory(scores : ScoresObject)
- 게임 승리가 판정났을 때 실행하는 메서드입니다.
onRoomLink(address : string)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
- 서버 가동 직후 링크가 생성될 시점에 호출되는 메서드입니다.
- API 레벨 8(2.2.0) 이후에는 서버가 재가동될 때, 서버 복구 메시지가 출력됩니다.
- API 레벨 8(2.2.0 r4) 이후에는 서버가 재가동될 때, reCAPTCHA가 활성화됩니다.
onKickRateLimitSet(min : int, rate : int, brust : int, player : PlayerObject)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 맵 정보를 초기화하는 메서드입니다.
-
mapsName
의 값을 제어합니다.
getTeamMark(num : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 팀 ID를 문자열로 치환하여 반한하는 메서드입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
-
link
의 값을 구하는 메서드입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 6(2.0.1) |
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 6(2.0.1) |
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 6(2.0.1) |
Administration 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
방 운영과 직결되는 관리 클래스입니다.
- 플레이어의 권한 동적 할당의 여부를 가지는 변수입니다.
- 플레이어 팀 이동 명령어의 사용 권한을 가지는 변수입니다.
- 방장의 팀 이동 권한을 가지는 변수입니다.
-
NOPLAYER
의 값이false
일 때만 유효합니다.
- 채팅 금지자 명단입니다.
- 플레이어의 공용 ID를 데이터로 저장합니다.
onPlayerAdminChange(player: PlayerObject, byPlayer: PlayerObject)
- 플레이어의 권한이 변경될 때 실행하는 메서드입니다.
-
player
: 권한이 변경되는 플레이어 |byPlayer
: 권한 변경을 주도하는 플레이어
onPlayerKicked(kickedPlayer, reason, ban, byPlayer)
- 플레이어가 강제 퇴장될 때 실행하는 메서드입니다.
-
kickedPlayer
: 강제 퇴장 대상자입니다. -
reason
: 퇴장 사유입니다. -
ban
: 영구 퇴장 여부입니다. 강제 퇴장은false
, 영구 퇴장은true
값을 가집니다. -
byPlayer
: 강제 퇴장 처리자입니다.
adminhelp(player: PlayerObeject)
- 관리 명령어 목록을 출력합니다.
adminComhelp(player: PlayerObeject)
- 관리 명령어 도움말을 출력합니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | addBlacklist(name : string) |
8(2.2.0)~ | addBlacklist(index : int) |
- 블랙리스트를 등록하는 메서드입니다.
-
name
의 인자값은 플레이어의 닉네임입니다. -
index
의 인자값은 플레이어의 공용 ID입니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | addSuperBlacklist(PublicId : int) |
8(2.2.0)~ | addSuperBlacklist(index : int) |
- 슈퍼 블랙리스트를 등록하는 메서드입니다.
-
PublicId
/index
의 인자값은 플레이어의 공용 ID입니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | getAdminstats(player : PlayerObject) |
7(2.1.0)~ | getAdminstats(player : int) |
- 플레이어의 권한을 확인하는 메서드입니다.
-
2
: 권한이 있으면 이 값을 반환합니다. -
1
: 보조 권한이 있으면 이 값을 반환합니다. -
false
: 아무 권한도 없으면 이 값을 반환합니다.
getAdmin(player: PlayerObject)
- 권리자 로그인을 성공하면 처리하는 메서드입니다.
getMute(player: int)
- 플레이어의 채팅 금지 여부를 처리하는 메서드입니다
- 채금자일 경우 채팅 금지 메시지를 출력합니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | setAdmin(player : PlayerObject) |
7(2.1.0)~ | setAdmin(player : int) |
- 플레이어의 권한을 설정하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | setSubAdmin(player : PlayerObject) |
7(2.1.0)~ | setSubAdmin(player : int) |
- 플레이어의 보조 권한을 설정하는 메서드입니다.
setDynamicAdmin(player : PlayerObject)
- 권한 동적 할당의 옵션을 처리하는 메서드입니다.
-
dynamicAdmin
의 값을 제어합니다.
setScore(player : PlayerObject, msg: string)
- 점수 변경 명령어를 처리하는 메서드입니다.
- 게임 진행 중에 사용할 수 없습니다.
setTime(player : PlayerObject, msg: string)
- 시간 변경 명령어를 처리하는 메서드입니다.
- 게임 진행 중에 사용할 수 없습니다.
setTeamsLock(player : PlayerObject)
- 팀 이동 명령어의 활성화 옵션을 처리하는 메서드입니다.
-
teamsLock
의 값을 제어합니다.
setHostLock(player : PlayerObject)
- 방장의 게임 참가 옵션을 처리하는 메서드입니다.
-
NOPLAYER
의 값이true
이면 호출을 거부합니다. -
hostLock
의 값을 제어합니다.
setAutoReset(player : PlayerObject)
- 게임 시작 또는 종료를 처리하는 메서드입니다.
setReset(player : PlayerObject)
- 게임 재시작 명령어를 처리하는 메서드입니다.
setPassword(player : PlayerObject, msg: string)
- 비밀번호 설정 명령어를 처리하는 메서드입니다.
setMute(mutedPlayer: int, byPlayer: int)
- 플레이어의 채팅을 금지하는 메서드입니다.
-
mutedPlayer
의 값이 유효하지 않으면 호출을 거부합니다. -
mutedList
의 값을 제어합니다.
setKick(kickedPlayer: int, msg: string, ban: bool)
- 플레이어를 퇴장시키는 메서드입니다.
-
ban
이true
이면 영구 퇴장으로 처리합니다. -
kicked
의 값을 제어합니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | setClearBans(player: PlayerObject) |
8(2.2.0)~ | clearBans(player: int) |
- 영구 퇴장 명단을 초기화하는 메서드입니다.
setPassword(player: PlayerObject)
- 설정된 비밀번호를 출력하는 메서드입니다.
- 비밀번호가 설정돼있지 않으면 출력하지 않습니다.
missPassword(player: PlayerObject)
- 권리자 로그인을 실패하면 처리하는 메서드입니다.
filerPlayer(player: PlayerObject)
- 사칭 및 다중 접속자를 필터링하는 메서드입니다.
- 동일한 닉네임을 가진 다중의 플레이어가 있으면 ID의 번호가 더 높은 플레이어가 퇴장됩니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | checkBlacklists(name: string) |
8(2.2.0)~ | checkBlacklists(index: int) |
- 블랙리스트를 감지하는 메서드입니다.
- API 레벨 7(2.1.0) 이후에는 닉네임에 특수문자가 있으면 해당 부분이 임의의 값으로 치환됩니다.
-
true
: 블랙리스트가 감지되면 반환되는 값입니다. -
false
: 블랙리스트가 아닐 경우 반환되는 값입니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | checkSuperBlacklists(name: string, id: int) |
8(2.2.0)~ | checkSuperBlacklists(id: int) |
- 슈퍼 블랙리스트를 감지하는 메서드입니다.
- 슈퍼 블랙리스트가 감지되면 해당 플레이어를 강제 퇴장합니다.
updateAdmins(player: PlayerObject)
- 권한 갱신을 처리하는 메서드입니다.
-
dynamic
의 값이true
이면 작동됩니다. - 권한을 가진 플레이어가 없을 때, ID가 제일 낮은 플레이어가 권한을 가집니다.
- 권한을 가진 플레이어가 없을 때, ID가 제일 낮은 플레이어가 블랙리스트이면 보조 권한을 가집니다.
updatePassword(pass: string)
- 비밀번호를 갱신하는 메서드입니다.
-
PASSWORD
의 값을 제어합니다.
releaseMute(player: PlayerObject)
- 금지된 플레이어의 채팅을 허용하는 메서드입니다.
releasePassword(player: PlayerObject)
- 비밀번호를 해제하는 메서드입니다.
-
password
의 값이 없으면 호출을 거부합니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | deleteAdmin(player : PlayerObject) |
7(2.1.0)~ | deleteAdmin(player : int) |
- 플레이어의 권한을 해제하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | deleteSubAdmin(player : PlayerObject) |
7(2.1.0)~ | deleteSubAdmin(player : int) |
- 플레이어의 보조 권한을 해제하는 메서드입니다.
putPause(player: PlayerObject)
- 게임을 일시적으로 중단하는 메서드입니다.
unPause(player: PlayerObject)
- 게임을 재개하는 메서드입니다.
Notice 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
알림 및 메시지를 관리하는 클래스입니다.
devCheck(player : PlayerObject)
acess(player : PlayerObject)
msgCommand(msg : string)
alterMsg(player : PlayerObject)
- 욕설이 감지되면 메시지를 출력하는 메서드입니다.
ruleCommand(msg : string)
anounce(msg : string, target : playerid, color : color, style : int, sound : int)
- 알림 메시지 함수입니다.
-
setColor()
를 호출합니다. -
setStyle()
을 호출합니다.
setColor(color : color)
- 알림 메시지의 글꼴 색상을 지정합니다.
-
color
가 조건문 외의 값을 가지면 "0xFFFFFF"로 반환합니다.
API 레벨 | 형식 |
---|---|
~5(2.0.0) | setStyle(style : int) |
6(2.0.1)~ | setStyle(style : int or string) |
- 알림 메시지의 글꼴 형식을 지정합니다.
- API 레벨 6(2.0.1) 이후에는 문자열을
style
의 인자값으로 전달할 수 있습니다.
ChatSystem 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
채팅 시스템에 관련된 클래스입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 채팅 모드의 수를 저장하는 변수입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 채팅의 얼림/녹임 여부를 저장하는 변수입니다.
- 강제 퇴장을 취할 수 있는 필러팅 단어입니다.
- 필터링 단어입니다.
getChatMode(player: PlayerObject)
- 플레이어의 채팅 모드를 구하는 메서드입니다.
getFace(emoji : face, name : string)
getSpace(string : string)
onPlayerChat(player : PlayerObject, msg : string)
- 플레이어가 채팅 메시지를 보낼 때 실행하는 메서드입니다.
- API 레벨 6(2.0.1) 이후에는 한 시간 간격으로 영구 퇴장 명단을 초기화합니다.
- 명령어 입력을 감지하고 처리합니다.
- 다중 접속자 경고창을 출력합니다.
- 70자 내외 글자수 제한이 있습니다.
filterWords(player : PlayerObject, msg : string)
- 단어를 필터링 하는 메서드입니다.
-
ffWords
의 값이 감지되면 해당 플레이어를 강제 퇴장합니다. -
fWords
의 값이 감지되면 경고 알림창을 출력합니다. - 필터링이 되지 않으면
true
값을 반환합니다.
sendAllChat(player : PlayerObject, msg : string)
- 전체 채팅을 출력하는 메서드입니다.
- 단어를 필터링 하기 위해
filterWords()
를 호출합니다. - 채금자의 채팅은 호출을 중단하고
false
값을 반환합니다. - 플레이어의 채팅 모드에 따라 채팅 메시지에서 도움말을 추가합니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | sendHideChat(player : PlayerObject, msg : string, type : bool) |
8(2.2.0)~ | sendHideChat(player : int, msg : string, type : bool) |
sendWhisperChat(toPlayer : int, fromPlayer : int, msg : string)
- 귓속말 채팅을 출력하는 메서드입니다.
-
toPlayer
는 귓속말 채팅을 전달받는 플레이어의 공용 ID입니다. -
fromPlayer
는 귓속말 채팅을 전달하는 플레이어의 공용 ID입니다. - 단어를 필터링 하기 위해
filterWords()
를 호출합니다.
sendTeamChat(team : int, player : int, msg : string)
- 팀 채팅을 출력하는 메서드입니다.
- 단어를 필터링 하기 위해
filterWords()
를 호출합니다. - 채금자의 채팅은 호출을 중단하고
false
값을 반환합니다. - 플레이어의 채팅 모드에 따라 채팅 메시지에서 도움말을 추가합니다.
sendMsg(msg : string, target : int)
- 일반 메시지를 출력하는 메서드입니다.
-
target
은 플레이어의 공용 ID입니다. -
NOPLAYER
의 값이true
이면 일반 메시지가 아닌Notice
클래스의announce
메서드로 출력됩니다.
setAllChat(player : PlayerObject, msg : string)
- 전체 채팅 명령어를 처리하는 메서드입니다.
- 50자 내외 글자수 제한이 있습니다.
setWhisperChat(player : PlayerObject, msg : string)
- 귓속말 채팅 명령어를 처리하는 메서드입니다.
- 70자 내외 글자수 제한이 있습니다.
setTeamChat(player : PlayerObject, msg : string)
- 팀 채팅 명령어를 처리하는 메서드입니다.
- 50자 내외 글자수 제한이 있습니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | setTeamChat(player : PlayerObject, msg : string) |
7(2.1.0)~ | setTeamChat(player : int, msg : string) |
- 채팅 모드를 설정하는 메서드입니다.
setDisruptMode(player : int, type : bool)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 귓속말 채팅 수신을 설정하는 메서드입니다.
-
type
의 값이true
이면 수신을 허용합니다. -
type
의 값이false
이면 수신을 차단합니다.
setFreezeChat(type : bool)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 채팅창을 얼리거나 녹이는 메서드입니다.
-
type
의 값이true
이면 채팅창을 얼립니다. -
type
의 값이false
이면 채팅창을 녹입니다.
Commands 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
명령어 동작을 담당하는 클래스입니다.
recommendCom(kind : string, commands : string)
plaster(player : PlayerObject)
- 도배방지문자를 출력하는 메서드입니다.
- 플레이어의 권한 또는 보조 권한이 없으면
comHelp()
를 호출합니다.
comHelp(player : PlayerObject, msg : string)
- 종합 도움말을 출력하는 메서드입니다.
- 권한 여부에 따라 출력 내용의 차이가 있습니다.
botHelp(player : PlayerObject, msg : string)
- 봇방 도움말을 출력하는 메서드입니다.
- 권한 여부에 따라 출력 내용의 차이가 있습니다.
chatHelp(player : PlayerObject, msg : string)
- 채팅 도움말을 출력하는 메서드입니다.
- 권한 여부에 따라 출력 내용의 차이가 있습니다.
mapHelp(player : PlayerObject, msg : string)
- 봇방 도움말을 출력하는 메서드입니다.
- 권한 여부에 따라 출력 내용의 차이가 있습니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | helpJoinP(player : PlayerObject) |
8(2.2.0)~ | joinHelpPers(player : PlayerObject) |
- 참가 도움말을 출력하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | helpJoinA(player : PlayerObject) |
8(2.2.0)~ | joinHelpPub(player : PlayerObject) |
- 참가 도움말을 출력하는 메서드입니다.
- 공용으로 출력됩니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | scoreHelp(player : PlayerObject) |
8(2.2.0)~ | rankHelp(player : PlayerObject) |
- 랭크 도움말을 출력하는 메서드입니다.
- 권한 여부에 따라 출력 내용의 차이가 있습니다.
etcHelp(player : PlayerObject, msg : string)
- 기타 도움말을 출력하는 메서드입니다.
- 권한 여부에 따라 출력 내용의 차이가 있습니다.
qE_Chat(player : PlayerObject)
- 귓속말 채팅의 상세 도움말을 출력하는 메서드입니다.
qT_Chat(player : PlayerObject)
- 팀 채팅의 상세 도움말을 출력하는 메서드입니다.
qMark(player : PlayerObject)
- 채팅 마크의 상세 도움말을 출력하는 메서드입니다.
qChatmode(player : PlayerObject)
- 채팅 모드의 상세 도움말을 출력하는 메서드입니다.
qScore(player : PlayerObject)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
6(2.0.1) | 8(2.2.0) |
- 점수 정보의 상세 도움말을 출력하는 메서드입니다.
qDisruptMode(player : PlayerObject)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 수신 모드의 상세 도움말을 출력하는 메서드입니다.
infoRoom(player : PlayerObject, msg : string)
- 방 상세 정보를 출력하는 메서드입니다.
- UMUX 기반임을 표기해야 합니다.
- 보안 패치 수준을 표기해야 합니다.
- 릴리스 날짜는 최신 업데이트 날짜와 동일합니다.
infoPlayers(player : PlayerObject)
- 모든 플레이어의 간단 정보를 나열한 목록을 출력하는 메서드입니다.
infoMaps(player : PlayerObject, msg : string)
- 내장된 맵의 상세 정보를 나열한 목록을 출력하는 메서드입니다.
- API 레벨 6(2.0.1) 이전에는 최대 50개까지 출력할 수 있습니다.
- API 레벨 7(2.1.0) 이후에는 내장 맵의 개수에 따라 유동적으로 출력됩니다.
infoScore(player : PlayerObject, msg : string)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 전적을 출력하는 메서드입니다.
-
index
의 값이 조건 내에서 유효하면 해당 값에 맞는 개인 ID를 가진 플레이어의 정보가 출력됩니다.
infoRanking(player : PlayerObject, msg : string)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 랭킹 정보를 출력하는 메서드입니다.
-
index
의 값이 조건 내에서 유효하면 해당 값에 맞는 개인 ID를 가진 플레이어의 정보가 출력됩니다.
setChatMode(player : PlayerObject, msg : string)
- 채팅 모드 설정 명령어를 처리하는 메서드입니다.
setDisruptMode(player : PlayerObject)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 수신 모드를 변경하는 메서드입니다.
setFreezeChat(player : PlayerObject)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 채팅창 얼리기 명령어를 처리하는 메서드입니다.
setUnFreezeChat(player : PlayerObject)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 채팅창 녹이기 명령어를 처리하는 메서드입니다.
setTeamColors(player : PlayerObject, msg : string)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 유니폼 변경 명령어를 처리하는 메서드입니다.
setJoinPlayer(includedTeam : TeamID, toTeam : TeamID, name : string, id : int)
- 플레이어 투입 명령어를 처리하는 메서드입니다.
- 플레이어의 권한 또는 보조 권한이 있으면 다른 플레이어의 개별 투입이 가능합니다.
-
Administration
클래스의teamsLock
의 값이true
로 되어있으면 호출을 중단합니다. -
Player
클래스의members
의asleep
의 값이true
로 되어있으면 호출을 중단합니다.
setJoinSpec(player : PlayerObject, msg : string)
- 관중석 이동 명령어를 처리하는 메서드입니다.
setJoinRed(player : PlayerObject, msg : string)
- 레드팀 이동 명령어를 처리하는 메서드입니다.
setJoinBlue(player : PlayerObject, msg : string)
- 블루팀 이동 명령어를 처리하는 메서드입니다.
infoRanking(player : PlayerObject, msg : string)
- 채팅 금지 명령어를 처리하는 메서드입니다.
- 플레이어 인원이 1명 이하(1명 포함)이면 호출을 거부합니다.
-
dId
의 값이 호출자의 개인 ID와 동일하면 호출을 거부합니다.
setSleep(player : PlayerObject)
- 장기 대기열 등록 명령어를 처리하는 메서드입니다.
setRecording(player : PlayerObject)
API 레벨 | 형식 |
---|---|
~6(2.0.1) | loadMap(player : PlayerObject, mapId : string) |
7(2.1.0)~ | loadMap(player : PlayerObject, msg : string) |
- 내장 맵 로드 명령어를 처리하는 메서드입니다.
- API 레벨 6(2.0.0) 이전에는 맵 ID를 1부터 12까지의 값만 인식됩니다.
- API 레벨 7(2.0.1) 이후에는 맵 ID를 내장 맵의 개수에 따라 유동적으로 인식됩니다.
Player 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
게임 플레이어와 관련된 클래스입니다.
- 접속 중인 플레이어의 인원입니다.
- 개별 플레이어 객체의 구조체입니다.
- 플레이어의 공용 네트워크입니다.
- 플레이어의 공용 주소입니다.
- 장기 대기 플레이어 명단(자동)입니다.
- 채팅 마크입니다.
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 7(2.1.0) |
- 슈퍼 블랙리스트 명단입니다.
- 블랙리스트 명단입니다.
onPlayerTeamChange(player: PlayerObject, byPlayer: PlayerObject)
- 팀이 교체될 때 실행하는 메서드입니다.
-
Administration
클래스의hostLock
의 값에 따라 방장의 팀 이동에 영향을 받습니다. -
members
의asleep
값에 따라 개별 플레이어의 팀 이동에 영향을 받습니다.
onPlayerActivity(player: PlayerObject)
initMember(data : PlayerObject)
-
members
객체를 초기화하는 메서드입니다.
initBlacklist(sp : bool, name : string, adrs : int)
- 블랙리스트 객체를 초기화하는 메서드입니다.
-
sp
의 값이true
이면 슈퍼 블랙리스트,false
이면 일반 블랙리스트로 등록됩니다. -
name
의 인자값은 플레이어 이름입니다. -
adrs
의 인자값은 플레이어의 공용 주소입니다.
getLocalId(Publicid : int)
- 플레이어의 개인 ID를 구하는 메서드입니다.
-
Publicid
의 값은 공용 ID입니다.
getPublicId(Privateid : int)
- 플레이어의 공용 ID를 구하는 메서드입니다.
-
Privateid
의 값은 개인 ID입니다.
getPlayer(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어 객체를 구하는 메서드입니다.
getGravityX(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 X 중력을 구하는 메서드입니다.
getGravityY(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 Y 중력을 구하는 메서드입니다.
getRadius(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 반지름을 구하는 메서드입니다.
getBcoeff(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 바운스를 구하는 메서드입니다.
getInvMass(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 역질량을 구하는 메서드입니다.
getDamping(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 제동을 구하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | getPosX(player : PlayerObject) |
7(2.1.0)~ | getPosX(player : int) |
- 플레이어의 X좌표를 구하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | getPosY(player : PlayerObject) |
7(2.1.0)~ | getPosY(player : int) |
- 플레이어의 Y좌표를 구하는 메서드입니다.
getSpeedX(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 X 속도를 구하는 메서드입니다.
getSpeedY(index : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 Y 속도를 구하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | getPosition(player : PlayerObject) |
7(2.1.0)~ | getPosition(player : int) |
- 플레이어의 좌표를 구하는 메서드입니다.
getAddress(searchId : int)
- 플레이어의 공용 주소를 구하는 메서드입니다.
getNetwork(searchId : int)
- 플레이어의 공용 네트워크를 구하는 메서드입니다.
setPosition(player : int, x : float, y : float)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 좌표를 지정하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | setX(player : PlayerObject, msg : float) |
7(2.1.0)~ | setPosX(player : int, x : float) |
- 플레이어의 X좌표를 지정하는 메서드입니다.
- API 레벨 6(2.0.1) 이전에는 소수점 아래 5자리까지만 인식합니다.
API 레벨 | 형식 |
---|---|
~6(2.0.1) | setY(player : PlayerObject, msg : float) |
7(2.1.0)~ | setPosY(player : int, x : float) |
- 플레이어의 Y좌표를 지정하는 메서드입니다.
- API 레벨 6(2.0.1) 이전에는 소수점 아래 5자리까지만 인식합니다.
setGravityX(player : int, gravityX : float)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 X 중력을 지정하는 메서드입니다.
setGravityY(player : int, gravityY : float)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 Y 중력을 지정하는 메서드입니다.
setRadius(player : int, r : float)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 반지름을 지정하는 메서드입니다.
setBcoeff(player : int, b : float)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 바운스를 지정하는 메서드입니다.
setInvMass(player : int, m : float)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 역질량을 지정하는 메서드입니다.
setDamping(player : int, d : float)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
- 플레이어의 제동을 지정하는 메서드입니다.
setAvatar(player : PlayerObject, msg : string)
- 플레이어의 등번호를 지정하는 메서드입니다.
setSleep(player : PlayerObject, sleep : bool)
- 장기 대기 플레이어를 설정하는 메서드입니다.
-
sleep
의 값이true
이면 장기 플레이어 명단에서 추가합니다. -
sleep
의 값이false
이면 장기 플레이어 명단에서 제거합니다.
setTeam(id : int, team : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
6(2.0.1) | 8(2.2.0) |
- 플레이어의 팀을 설정하는 메서드입니다.
-
team
의 값이0
이면 관중석으로 이동합니다. -
team
의 값이1
이면 레드팀으로 이동합니다. -
team
의 값이2
이면 블루팀으로 이동합니다.
setTeamColors(team : int, angle : int, txtColor : color, bgColor : color)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 유니폼 변경 명령어를 처리하는 메서드입니다.
setTeam(id : int, team : int)
- 플레이어의 팀을 지정하는 메서드입니다.
setAddress(player : int, address : int)
- 플레이어의 공용 주소를 지정하는 메서드입니다.
setNetwork(player : int, address : int)
- 플레이어의 공용 네트워크를 지정하는 메서드입니다.
setSleepPlayer(player : PlayerObject)
- 장기 대기 플레이어를 등록하는 메서드입니다.
- 플레이어의 채팅 마크를 갱신하는 메서드입니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | updatePlayers(player : PlayerObject) |
8(2.2.0)~ | updatePlayers(player : int) |
- 플레이어의 개인 ID를 갱신하는 메서드입니다.
-
members
의 값을 제어합니다.
checkMarks(player : PlayerObject, type : int)
- 플레이어의 채팅 마크를 확인하는 메서드입니다.
- 팀 채팅일 경우, 팀별로 감지합니다.
clearMember(data : PlayerObject)
-
members
객체를 지우는 메서드입니다.
deleteSleppPlayer(player : PlayerObject)
- 장기 대기열 플레이어를 제거하는 메서드입니다.
resetAvatar(player : PlayerObject)
- 플레이어의 등번호를 초기화하는 메서드입니다.
- 등번호는 플레이어의 개인 ID로 지정됩니다.
Scores 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
7(2.1.0) | 8(2.2.0) |
랭킹 및 전적 시스템의 작동 기반 클래스입니다.
- 레드팀의 골 누적 개수를 저장하는 변수입니다.
- 블루팀의 골 누적 개수를 저장하는 변수입니다.
- 공을 잡은 선두 플레이어의 공용 ID를 저장하는 변수입니다.
- 개별 플레이어의 전적 정보를 저장하는 객체의 구조체입니다.
- 점수 증차감량에 관한 객체의 배열입니다.
initStatus(player : int)
- 플레이어의 전적 정보를 초기화하는 메서드입니다.
- 점수가 아닌 횟수를 데이터로 저장합니다.
initRanking(player : int)
- 플레이어의 랭킹 순위를 초기화하는 메서드입니다.
- 선두 플레이어를 초기화하는 메서드입니다
- 레드팀의 골 개수를 구하는 메서드입니다.
- 블루팀의 골 개수를 구하는 메서드입니다.
- 레드팀의 누적 골 개수를 구하는 메서드입니다.
- 블루팀의 누적 골 개수를 구하는 메서드입니다.
- 승리 팀을 판정하는 메서드입니다.
-
1
: 레드팀이 승리하면 이 값을 반환합니다. -
2
: 블루팀이 승리하면 이 값을 반환합니다. -
3
: 무승부이면 이 값을 반환합니다.
- 게임 시간을 구하는 메서드입니다.
getStatsWin(index : int)
- 플레이어의 우승 전적을 구하는 메서드입니다.
getStatsWin(index : int)
- 플레이어의 우승 전적을 구하는 메서드입니다.
getStatsLost(index : int)
- 플레이어의 패배 전적을 구하는 메서드입니다.
getStatsGoal(index : int)
- 플레이어의 골 전적을 구하는 메서드입니다.
getStatsOG(index : int)
- 플레이어의 자책골 전적을 구하는 메서드입니다.
getPlayerStats(player : int)
- 플레이어의 전적 정보를 구하는 메서드입니다.
getRanking(player : int)
- 플레이어의 랭킹 순위를 구하는 메서드입니다.
getDisc(index : int)
- 디스크 객체를 구하는 메서드입니다.
getDiscPosition(index : int)
- 디스크의 좌표를 구하는 메서드입니다.
getDiscPosX(index : int)
- 디스크의 X좌표를 구하는 메서드입니다.
getDiscPosY(index : int)
- 디스크의 Y좌표를 구하는 메서드입니다.
getDiscSpeedX(index : int)
- 디스크의 X 속도를 구하는 메서드입니다.
getDiscSpeedY(index : int)
- 디스크의 Y 속도를 구하는 메서드입니다.
getDiscGravityX(index : int)
- 디스크의 X 중력을 구하는 메서드입니다.
getDiscGravityY(index : int)
- 디스크의 Y 중력을 구하는 메서드입니다.
getDiscRadius(index : int)
- 디스크의 반지름을 구하는 메서드입니다.
getDiscBcoeff(index : int)
- 디스크의 바운스를 구하는 메서드입니다.
getDiscInvMass(index : int)
- 디스크의 역질량을 구하는 메서드입니다.
getDiscDamping(index : int)
- 디스크의 제동을 구하는 메서드입니다.
getDiscColor(index : int)
- 디스크의 색상을 구하는 메서드입니다.
- 10진수의 값으로 반환합니다.
getDiscColMask(index : int)
- 디스크의 충돌 마스크를 구하는 메서드입니다.
getDiscColGroup(index : int)
- 디스크의 충돌 그룹을 구하는 메서드입니다.
getDistance(index : int)
- 두 객체 간의 거리를 구하는 메서드입니다.
- 선두 플레어어의 ID를 구하는 메서드입니다.
sendRanking(index : int, player : int)
- 랭킹 메시지를 보내는 메서드입니다.
-
index
의 랭킹 정보를 보냅니다. -
player
를 대상으로 출력합니다.
setHolder(player : int)
- 선두 플레이어를 지정하는 메서드입니다.
setStatsWin(index : int, value : int)
- 플레이어의 승리 전적을 지정하는 메서드입니다.
setStatsLost(index : int, value : int)
- 플레이어의 패배 전적을 지정하는 메서드입니다.
setStatsGoal(index : int, value : int)
- 플레이어의 골 전적을 지정하는 메서드입니다.
setStatsOG(index : int, value : int)
- 플레이어의 자책골 전적을 지정하는 메서드입니다.
setRanking(newIndex, oldIndex)
- 랭킹을 지정하는 메서드입니다.
updateHolder(id : int)
- 선두 플레이어를 갱신하는 메서드입니다.
- 누적 골 개수를 갱신하는 메서드입니다.
- 전적을 갱신하는 메서드입니다.
showPlayerStats(player : int)
- 플레이어의 점수 정보를 출력하는 메서드입니다.
showRankingStats(player : int)
- 전적 상세 정보를 출력하는 메서드입니다.
TimeManager 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
날짜 및 시간과 관련된 클래스입니다.
- Windows 작업 표시줄 형식으로 시간을 출력하는 메서드입니다.
IoSystem 클래스
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
5(2.0.0) | 8(2.2.0) |
- 내부 시스템 또는 서버 초기화를 담당하는 클래스입니다.
- 절대 임의로 값을 수정하거나 변경해서는 안 됩니다.
- 서버 초기화 여부를 저장하는 변수입니다.
- 절대 임의로 값을 수정하거나 변경해서는 안 됩니다.
- 서버 버전입니다.
- UMUX 기반 버전을 저장하는 변수입니다.
- 절대 임의로 값을 수정하거나 변경해서는 안 됩니다.
- UMUX 보안 패치 수준을 저장하는 변수입니다.
- 절대 임의로 값을 수정하거나 변경해서는 안 됩니다.
log(io : bool, msg : string)
- 콘솔창을 입출력하는 메서드입니다.
-
io
의 값이true
이면 콘솔창에서 방으로 입력합니다. -
io
의 값이false
이면 방에서 콘솔창으로 출력합니다.
- 서버 초기화 여부를 확인하는 메서드입니다.
- 서버를 초기화하는 메서드입니다.
-
initialized
의 값을 제어합니다. - 서버 초기화 후, 알림 메시지를 출력합니다.
- API 8(2.2.0) 이후에는 서버 정보를 추가적으로, 간략하게 출력합니다.
setRequireRecaptcha(isActive : bool)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- API 레벨 8(2.2.0 r4) 및 2020.04.15 보안 패치부터 지원합니다.
- Recaptcha를 설정하는 메서드입니다.
-
isActive
의 값이true
이면 활성화,false
이면 비활성화합니다.
setLine(amount : string, line : int)
- 숫자의 자릿수를 교정하는 메서드입니다.
- 서버 및 시스템 정보를 출력하는 메서드입니다.
- 서버 버전이 포함됩니다.
- UMUX 기반 버전이 포함됩니다.
- UMUX 보안 패치 수준이 포함됩니다.
- 절대 임의로 값을 수정하거나 변경해서는 안 됩니다.
showPlayerInfo(player : int)
최소 지원 레벨 | 권장 지원 레벨 |
---|---|
8(2.2.0) | 8(2.2.0) |
- 플레이어의 ID 및 닉네임을 반환하는 메서드입니다.
기타
var commands : []commandsObject
- 명령어 대응을 담당하는 변수입니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | const maps : []stadiumObject |
8(2.2.0)~ | var maps : []stadiumObject |
- 시스템 내장 맵 데이터를 저장하는 변수입니다.
API 레벨 | 형식 |
---|---|
~7(2.1.0) | const mapsName : []string |
8(2.2.0)~ | var mapsName : []string |
- 시스템 내장 맵의 이름 데이터를 저장하는 변수입니다.