UMUX Reference_9 - HonestSquare/UMUX GitHub Wiki
- 본 문서는 API 레벨 9(3.0.0 Cairo)를 기반으로 작성된 UMUX 레퍼런스입니다.
-
Ctrl
+F
를 통해 개별 열람이 가능합니다.
- 변수 및 함수 위치는 이름의 접두사를 우선하되 로마자(A-Z) 순대로 정렬하였습니다.
접두사 목록
- on
- init
- is(has), get
- set
- add
- update, check
- clear, delete, reset
- show
- 상기 목록에서 일치하는 접두사가 없는 경우, show 접두사보다도 아래에 위치해 두었습니다.
- 다만 일부는 편의상을 이유로 예외 정렬한 곳도 있어, 소스 코드의 모든 객체가 위치를 이 규칙에 따라 정렬된 건 아닙니다.
초기 설정
ROOMNAME
const ROOMNAME : string
- 서버 이름을 저장하는 상수 변수입니다.
DESCRIPTION
const DESCRIPTION : string
- 서버 설명을 저장하는 상수 변수입니다.
MAXLIMIT
const MAXLIMIT : int
- 서버 최대 인원을 저장하는 상수 변수입니다.
HOSTNAME
const HOSTNAME : string
- 방장의 이름을 저장하는 상수 변수입니다.
PUBLIC
const PUBLIC : bool
- 서버의 공개 여부를 저장하는 상수 변수입니다.
NOPLAYER
const NOPLAYER : bool
- 방장의 여부를 저장하는 상수 변수입니다.
REGION_CODE
const REGION_CODE : string
- 서버의 지역 코드를 저장하는 상수 변수입니다.
LAT
const LAT : string
- 서버가 위치할 위도를 저장하는 상수 변수입니다.
LON
const LON : string
- 서버가 위치할 경도를 저장하는 상수 변수입니다.
PASSWORD
var PASSWORD : string
- 서버의 비밀번호를 저장하는 변수입니다.
GameManger 클래스
- 게임 이벤트 제어를 담당하는 클래스입니다.
handleGameStart
const handleGameStart(void)
- 게임 제어를 시작하는 상수 메서드입니다.
-
gameStats
변수의 값을 변경합니다. -
countMatch
변수의 값을 변경합니다. -
firstTimeNotified
변수의 값을 초기화합니다. -
lastTimeNotified
변수의 값을 초기화합니다. -
timeLimitReached
에false
의 값을 대입합니다. - 선두자 데이터베이스를 모두 지우기 위해
Scores
클래스의clearTouchedList()
메서드를 호출합니다. - 모든 플레이어의 마지막 활동 시간을 저장하기 위해
Player
클래스의updateTime()
메서드를 호출합니다.
handleGameTick
const handleGameTick(currentTime : double) : bool
- 게임 제어를 처리하는 상수 메서드입니다.
-
currentTime
의 값은 밀리초 단위입니다. -
gameStats
의 값이2
가 아닌 경우 해당 값으로 대입한 뒤, 그래픽 유저 인터페이스를 갱신하기 위해IoSystem
클래스의updateWebGUI()
메서드를 호출합니다. - 선두자 갱신을 위해
Scores
클래스의updateTouchedList()
메서드를 호출합니다. - 장기 무응답 플레이어 판정을 위해
GameManger
클래스의checkAfkPlayer()
메서드를 호출합니다. -
timeLimit
변수의 값이 1 미만인 경우, 처리를 중단하고false
의 값으로 반환합니다. -
currentTime
과lastTimeNotified
를 감산한 값보다 초 단위로 변환한timeLimit
보다 초과된 경우,currentTime
의 값을lastTimeNotified
변수에 대입한 뒤에true
의 값으로 반환합니다. -
timeLimitReached
변수의 값이false
이며currentTime
과lastTimeNotified
를 감산한 값보다 초 단위로 변환한timeLimit
보다 크거나 같은 경우,true
의 값을timeLimitReached
변수에 대입한 뒤에true
의 값으로 반환합니다.
afkLimitTime
let afkLimitTime : int
- 무응답 판정 최소 시간을 저장하는 변수입니다.
- 초 단위의 값입니다.
countMatch
let countMatch : int
- 누적 경기 횟수를 저장하는 변수입니다.
gameStats
let gameStats : int
- 경기 상태를 저장하는 변수입니다.
isRecording
let isRecording : bool
- 녹화 여부를 저장하는 변수입니다.
link
let link : string
- 서버 링크를 저장하는 변수입니다.
firstTimeNotified
let firstTimeNotified : int
- 최초 도달 시간을 저장하는 변수입니다.
- 초 단위의 값입니다.
lastTimeNotified
let lastTimeNotified : int
- 최근 도달 시간을 저장하는 변수입니다.
- 초 단위의 값입니다.
timeLimit
let timeLimit : int
- 도달 기준 시간을 저장하는 변수입니다.
- 초 단위의 값입니다.
timeLimitReached
let timeLimitReached : bool
- 시간 도달 여부를 저장하는 변수입니다.
onGamePause
onGamePause(player : PlayerObject)
- 경기 중단 시 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. -
gameStats
변수의 값을 변경합니다. - 그래픽 유저 인터페이스를 갱신하기 위해
IoSystem
클래스의updateWebGUI()
메서드를 호출합니다. - (리비전 6~)경기 미진행 중, 장기 무응답 플레이어 판정을 위해
GameManger
클래스의checkAfkPlayer()
메서드를 호출합니다.
onGameStart
onGameStart(void)
- 경기 시작 시 호출되는 메서드입니다.
- 게임 제어를 시작하기 위해
handleGameStart()
메서드를 호출합니다. - 누적 경기 횟수를 콘솔 로그로 출력합니다.
onGameStop
onGameStop(void)
- 경기 종료 시 호출되는 메서드입니다.
-
gameStats
변수의 값을 변경합니다. - 랭킹 갱신을 위해
Scores
클래스의updateRanking()
메서드를 호출합니다. - 그래픽 유저 인터페이스를 갱신하기 위해
IoSystem
클래스의updateWebGUI()
메서드를 호출합니다. - 경기 미진행 중, 장기 무응답 플레이어 판정을 위해
GameManger
클래스의checkAfkPlayer()
메서드를 호출합니다.
onGameTick
onGameTick(void)
- 경기 진행 시 호출되는 메서드입니다.
- 게임 제어를 처리하기 위해 100 밀리초 간격으로
handleGameTick()
메서드를 호출합니다.
onGameUnpause
onGameUnpause(player : PlayerObject)
- 경기 재개 시 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. -
gameStats
변수의 값을 변경합니다. - 그래픽 유저 인터페이스를 갱신하기 위해
IoSystem
클래스의updateWebGUI()
메서드를 호출합니다.
onKickRateLimitSet
onKickRateLimitSet(min : int, rate : int, burst : int , player : PlayerObject)
- 킥 제한이 설정될 때 호출되는 메서드입니다.
-
min
의 인자값은 두 킥 간의 최소 로직프레임입니다. -
rate
의 인자값은burst
의 값에 따른 추가 킥이 쓰일 값입니다. -
burst
의 인자값은 추가 킥을 절약할 수 있는 값입니다. -
player
의 인자값은 플레이어 객체입니다.
onPlayerBallKick
onPlayerBallKick(player : PlayerObject)
- 공을 찼을 때 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. - 선두자 데이터베이스 추가를 위해
Scores
클래스의addTouchedList()
메서드를 호출합니다.
onPlayerJoin
onPlayerJoin(player : PlayerObject)
- 플레이어 입장 시 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. - 입장 플레이어의 데이터베이스를 추가하고 초기화를 위해
Player
클래스의initPlayerList()
메서드를 호출합니다. - 전적 데이터베이스를 추가하고 초기화를 위해
Scores
클래스의initStatsList()
메서드를 호출합니다. - 랭킹 갱신을 위해
Scores
클래스의updateRanking()
메서드를 호출합니다. -
IoSystem
클래스의DEV
상수의 값이true
인 경우, 추가 메시지를 출력합니다. - 공용 주소 부여를 위해
Player
클래스의setAddress()
메서드를 호출합니다. - 공용 네트워크 부여를 위해
Player
클래스의setNetwork()
메서드를 호출합니다. - 계정 데이터베이스 갱신을 위해
Player
클래스의updateAccount()
메서드를 호출합니다. - 접속자 인원을 콘솔 로그로 출력합니다.
- (슈퍼)블랙리스트, 중복/다중 접속을 탐지하기 위해,
Administration
클래스의isSuperBlacklist()
및filterPlayer()
메서드를 호출합니다. - 입장 메시지를 출력합니다.
- 접속자가 2명 미만인 경우, 투입하고 경기를 시작합니다.
- 권한 갱신을 위해
Administration
클래스의updateAdmins()
메서드를 호출합니다.
onPlayerLeave
onPlayerLeave(player : PlayerObject)
- 플레이어 퇴장 시 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. - 퇴장 플레이어의 데이터베이스 삭제를 위해
Player
클래스의clearPlayerList()
메서드를 호출합니다. - 접속자가 더 이상 없는 경우, 경기를 종료하고 비밀번호를 해제하기 위해
Administration
클래스의updatePassword()
메서드를 호출합니다. -
Administration
클래스의updateAdmins()
메서드를 호출합니다. - 남은 접속자 인원을 콘솔 로그로 출력합니다.
onPositionsReset
onPositionsReset(void)
- 득실점 판정 직후 참가자 좌표 초기화에 호출되는 메서드입니다.
- 선두자 데이터베이스를 모두 지우기 위해
Scores
클래스의clearTouchedList()
메서드를 호출합니다.
onRoomLink
onRoomLink(address : string)
- 링크 획득 시 호출되는 메서드입니다.
-
GameManager
클래스의setLink()
메서드를 호출합니다. - 서버 초기화가 필요한 경우 처리를 중단하고 반환합니다.
-
IoSystem
클래스의setRequireRecaptcha()
메서드를 호출합니다.
onStadiumChange
onStadiumChange(newMap : string, byPlayer : PlayerObject)
- 맵 교체 시 호출되는 메서드입니다.
-
byPlayer
의 인자값은 플레이어 객체입니다. -
GameManager
클래스의updateStadiumsData()
메서드를 호출합니다. -
byPlayer
가 적절한 값으로 있는 경우, 해당 플레이어의 활동 시간을 저장하기 위해Player
클래스의updateTime()
메서드를 호출합니다. -
Administration
클래스의lockStadium[1]
의 값이true
인 경우,lockStadium[0]
의 데이터를 가진 맵으로 교체합니다.
onTeamGoal
onTeamGoal(team : teamId)
- 골 판정 시 호출되는 메서드입니다.
- 선두자의 데이터베이스를 구하기 위해
Scores
클래스의getLastTouchedPlayer()
메서드를 호출합니다. - 어시스트를 판정하기 위해
Scores
클래스의getAssist()
메서드를 호출합니다. - 득점 데이터 갱신을 위해
Scores
클래스의updateGoals()
메서드를 호출합니다. - 그래픽 유저 인터페이스를 갱신하기 위해
IoSystem
클래스의updateWebGUI()
메서드를 호출합니다. - 랭킹 갱신을 위해
Scores
클래스의updateRanking()
메서드를 호출합니다.
onTeamVictory
onTeamVictory(scores : ScoresObject)
- 팀 승리 이벤트를 호출하는 메서드입니다.
- 승리 팀 판정을 위해
Scores
클래스의getWinner()
메서드를 호출합니다. - 랭킹 갱신을 위해
Scores
클래스의updateRanking()
메서드를 호출합니다.
getAfkLimitTime
getAfkLimitTime(void) : int
- 무응답 판정 최소 시간을 반환하는 메서드입니다.
-
afkLimitTime
변수의 값이10
미만인 경우,0
의 값으로 반환합니다. -
afkLimitTime
변수의 값이10800
보다 초과된 경우,10800
의 값으로 반환합니다. -
afkLimitTime
변수의 값으로 반환합니다.
getGameStats
getGameStats(void) : int
- 경기 상태를 반환하는 메서드입니다.
-
gameStats
변수의 값으로 반환합니다.
getLink
getLink(void) : string
- 서버 링크를 반환하는 메서드입니다.
-
link
변수의 값으로 반환합니다.
getStateRecording
getStateRecording(void) : bool
- 녹화 상태를 반환하는 메서드입니다.
-
isRecording
변수의 값으로 반환합니다.
getTeamName
getTeamName(team : teamId) : string
- 팀 상태를 문자열로 반환하는 메서드입니다.
-
team
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다.
setAfkLimitTime
setAfkLimitTime(time : int)
- 장기 무응답 판정 최소 시간을 지정하는 메서드입니다.
-
time
의 값이 부적절하거나 찾을 수 없는 경우, 무응답 판정을 비활성화 합니다. -
time
의 값이 범위를 벗어난 경우, 처리를 중단하고 반환합니다. -
afkLimitTime
변수의 값을 변경합니다.
setLink
setLink(address : string)
- 서버 링크를 지정하는 메서드입니다.
-
link
변수의 값을 변경합니다.
updateStadiumsData
updateStadiumsData(void)
- 서버에 저장된 맵 데이터를 갱신하는 메서드입니다.
checkAfkPlayer
checkAfkPlayer(player : PlayerObject.id, time : double) : bool
- 장기 무응답 플레이어를 판정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
time
의 값은 밀리초 단위를 가집니다. - 장기 무응답 판정 시간의 값이 없거나 부적절한 경우, 처리를 중단하고
false
의 값으로 반환합니다. -
gameStats
변수의 값이2
일 때 플레이어 데이터베이스의team
값이TEAM
의SPECTATOR
값과 동일한 경우, 처리를 중단하고false
의 값으로 반환합니다. -
gameStats
변수의 값이2
일 때 플레이어 데이터베이스의isSleep
값이true
경우, 처리를 중단하고false
의 값으로 반환합니다. -
gameStats
변수의 값이2
일 때 플레이어의 권한이 있는 경우, 처리를 중단하고false
의 값으로 반환합니다. -
time
에서 플레이어 데이터베이스의time
을 감산한 값이 징기 무응답 판정 시간보다 초과된 경우,Player
클래스의onPlayerInactivity()
메서드를 호출하고true
의 값으로 반환합니다.
checkPublicId
checkPublicId(msg : string, player : PlayerObject.id) : int
- #ID 꼴의 문자열을 판별하여 공용 ID의 값을 정수형으로 반환하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
msg
의 값을 찾을 수 없는 경우, 처리를 중단하고 반환합니다. -
"#"
의 값을 색인하기 위해startPos
변수를 선언합니다. -
msg
에서 공용 ID의 정수형의 추출 값으로 저장하기 위해num
변수를 선언합니다. -
startPos
의 값이-1
인 경우, 처리를 중단하고 반환합니다. -
num
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. -
num
의 값으로 반환합니다.
cntMatch
cntMatch(void) : int
- 누적 경기 횟수를 반환하는 메서드입니다.
-
countMatch
변수의 값으로 반환합니다.
reorderPlayers
reorderPlayers(indexList : []object, moveToTop : bool)
- 플레이어 데이터베이스 순번을 재정렬 하는 메서드입니다.
-
indexList
의 인자값은 플레이어의 공용 ID를 저장한 배열입니다. - 재정렬 할 플레이어 명단을 저장하기 위해
indexArray
를 선언합니다. -
moveToTop
의 값이 부적절하거나 찾을 수 없는 경우,true
의 값으로 처리합니다. - 그래픽 유저 인터페이스의 플레이어 데이터베이스 갱신을 위해,
IoSystem
클래스의updateListIndex()
메서드를 호출합니다.
runCommand
runCommand(array : []object, index : string, msg : string, player : PlayerObject.id) : []object
- 명령어 기능을 처리하는 메서드입니다.
-
array
의 인자값은 명령어 객체입니다. -
index
의 인자값은 색인할 명령어 문자열입니다. -
msg
의 인자값은 입력된 메시지 문자열입니다. -
player
의 인자값은 플레이어의 공용 ID입니다. -
array
의 속성에index
의 값이 색인되지 않는 경우, 처리를 중단하고 오류를 전송합니다. -
msg
에서index
를 제외한 추가 문자열을 저장할comText
변수를 선언합니다. -
msg
와index
의 값이 동일한 경우,comText
변수는-1
의 값으로 초기화합니다. - 명령어 유형을 판정을 위해
msg
의 첫글자 특수문자 추출 값을 저장할comType
변수를 선언합니다. -
comType
의 값이'!'
인 경우comIndex
변수를0
의 값으로 대입합니다. -
comType
의 값이'?'
인 경우comIndex
변수를0
의 값으로 대입합니다. -
array
객체의index
속성 값으로 반환합니다.
startRecording
startRecording(void)
- 녹화 시작을 처리하는 메서드입니다.
-
isRecording
변수의 값이true
인 경우,stopRecording()
메서드를 호출합니다. -
isRecording
변수의 값을 변경합니다. - 녹화 시작 시간을 출력하기 위해
TimaManager
클래스의showCurrentTime()
메서드를 호출합니다.
stopRecording
stopRecording(void) : Uint8Array
- 녹화 종료를 처리하는 메서드입니다.
-
isRecording
변수의 값을 변경합니다. -
file
의 값이 유효하지 않거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다. - 녹화 종료 시간을 출력하기 위해
TimaManager
클래스의showCurrentTime()
메서드를 호출합니다. -
file
의 값으로 반환합니다.
Administration 클래스
- 서버 운영을 담당하는 클래스입니다.
blacklist
let blacklist : []object
- 블랙리스트의 데이터베이스를 저장하는 객체입니다.
dynamicAdmin
let dynamicAdmin : bool
- 플레이어 권한 할당 방식을 저장하는 변수입니다.
lockJoin
let lockJoin : bool
- 플레이어 팀 자율 이동 제한 여부를 저장하는 변수입니다.
lockStadium
let lockStadium : []object
- 고정 맵 데이터를 저장하는 배열입니다.
maxAdmin
let maxAdmin : int
- 최고 관리자 상한 인원을 저장하는 변수입니다.
pinHost
let pinHost : bool
- 방장 팀 이동 허용 여부를 저장하는 변수입니다.
onPlayerAdminChange
onPlayerAdminChange(player : PlayerObject, byPlayer : PlayerObject)
- 플레이어의 최고 권한 변경 시 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. -
byPlayer
의 인자값은 플레이어 객체입니다. -
player.admin
의 값이true
일 때, 블랙리스트에 포함되는 경우, 최고 권한을 삭제하기 위해deleteAdmin()
메서드를 호출과 동시에 반환합니다. -
player.admin
의 값이true
일 때, 최고 권한을 가진 접속자의 수가maxAdmin
변수의 값보다 큰 경우, 최고 권한을 삭제하기 위해deleteAdmin()
메서드를 호출과 동시에 반환합니다. -
player.admin
의 값이false
일 때, 보조 권한을 부여하기 위해giveSubAdmin()
메서드를 호출합니다. - 플레이어 데이터베이스의
sub_admin
값을 변경합니다. - 플레이어 데이터베이스의
admin
값을 변경합니다. - 그래픽 유저 인터페이스의 플레이어 데이터베이스 갱신을 위해,
IoSystem
클래스의updateListIndex()
메서드를 호출합니다.
onPlayerKicked
onPlayerKicked(kickedPlayer : PlayerObject, reason : string, ban : bool, byPlayer : PlayerObject)
- 플레이어 강제 퇴장 직후 호출되는 메서드입니다.
-
kickedPlayer
의 인자값은 플레이어 객체입니다. -
byPlayer
의 인자값은 플레이어 객체입니다. - 플레이어 데이터베이스의
hasKicked
값을true
의 값으로 변경합니다. -
reason
의 값이"Bad actor"
인 경우, 오류를 전송하고 처리를 중단합니다. -
byPlayer
가 적절한 값으로 있는 경우, 해당 플레이어의 활동 시간을 저장하기 위해Player
클래스의updateTime()
메서드를 호출합니다.
initBlacklist
initBlacklist(isSuper : bool, name : PlayerObject.name, adrs : string)
- 블랙리스트의 데이터베이스를 초기화하는 메서드입니다.
-
adrs
의 인자값은 플레이어의 공용 주소입니다. -
isSuper
의 값이true
이면 슈퍼 블랙리스트로 등록합니다. -
isSuper
의 값이false
이면 블랙리스트로 등록합니다. -
isSuper
의 값이 부적절하거나 찾을 수 없는 경우,super
를false
의 값으로 선언과 동시에 초기화합니다. -
name
의 값이 부적절하거나 찾을 수 없는 경우,name
을undefined
의 값으로 선언과 동시에 초기화합니다. -
adrs
의 값이 부적절하거나 찾을 수 없는 경우,ip
를undefined
의 값으로 선언과 동시에 초기화합니다.
isBlacklist
isBlacklist(index : PlayerObject.id) : bool
- 블랙리스트 여부를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. - 공백 닉네임인 경우, 처리를 중단하고 반환합니다.
- 특수문자가 포함된 닉네임의 경우, 특정 문자로 치환합니다.
- 검색할 데이터베이스가 슈퍼 블랙리스트인 경우, 다음 인덱스의 데이터를 불러옵니다.
- 검색할 데이터베이스의 이름이 없는 경우, 다음 인덱스의 데이터를 불러옵니다.
- 검색할 데이터베이스의 주소 데이터가 없는 경우 등록합니다.
- 플레이어가 블랙리스트로 감지된 경우
true
의 값으로 반환합니다. - 플레이어가 블랙리스트로 감지되지 않은 경우
false
의 값으로 반환합니다.
isLockJoin
isLockJoin(void) : bool
- 팀 자율 이동 제한 여부를 반환하는 메서드입니다.
-
lockJoin
변수의 값으로 반환합니다.
isLockStadium
isLockStadium(void) : bool
- 맵 고정 여부를 반환하는 메서드입니다.
-
lockStadium[1]
의 값으로 반환합니다.
isMute
isMute(player : PlayerObject.id, msg : string) : bool
- 채팅이 금지된 플레이어를 감지하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
player
의 값이0
이거나 플레이어 데이터베이스의isMute
값이false
인 경우, 처리를 중단하고 반환합니다. - 채팅 금지 문구 메시지를 출력합니다.
- 감정 채팅 전송을 처리하기 위해
ChatSystem
클래스의sendEmojiChat()
메서드를 호출합니다.
isPinHost
isPinHost(void) : bool
- 방장 팀 이동 허용 여부를 반환하는 메서드입니다.
-
NOPLAYER
의 값이true
이면,false
의 값으로 반환합니다. -
pinHost
변수의 값으로 반환합니다.
isSuperBlacklist
isSuperBlacklist(index : PlayerObject.id) : bool
- 슈퍼 블랙리스트 여부를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. - 공백 닉네임인 경우, 처리를 중단하고 반환합니다.
- 특수문자가 포함된 닉네임의 경우, 특정 문자로 치환합니다.
- 검색할 데이터베이스의 이름이 동일할 때 주소 데이터가 불일치하면 슈퍼 블랙리스트 데이터베이스를 등록하기 위해
initBlacklist()
메서드를 호출합니다. - 검색할 데이터베이스의 주소가 동일할 때 이름 데이터가 불일치하면 슈퍼 블랙리스트 데이터베이스를 등록하기 위해
initBlacklist()
메서드를 호출합니다. - 검색할 데이터베이스 원소의 데이터가 없는 경우 등록합니다.
- 중복된 데이터베이스를 삭제합니다.
- 강제 퇴장을 실행하기 위해
setKick()
메서드를 호출합니다. - 플레이어가 슈퍼 블랙리스트로 감지된 경우
true
의 값으로 반환합니다. - 플레이어가 슈퍼 블랙리스트로 감지되지 않은 경우
false
의 값으로 반환합니다.
getAdmin
getAdmin(player : PlayerObject.id) : int
- 플레이어의 권한을 반환하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
player
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다. - 플레이어 데이터베이스의
admin
의 값이true
인 경우,2
의 값으로 반환합니다. - 플레이어 데이터베이스의
sub_admin
의 값이true
인 경우,1
의 값으로 반환합니다. - 상기의 두 조건 모두 만족하지 않는 경우,
false
의 값으로 반환합니다.
getBlacklist
getBlacklist(index : PlayerObject.id) : object | []object
- 블랙리스트의 데이터베이스를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. -
index
의 값이 부적절하거나 찾을 수 없는 경우,blacklist
전체 객체로 반환합니다.
getMaxAdmin
getMaxAdmin(void) : int | bool
- 최고 관리자 상한 인원을 반환하는 메서드입니다.
-
maxAdmin
변수의 값이MAXPLAYERS
의 값보다 크거나,maxAdmin
변수의 값이 1 미만인 경우,false
의 값으로 반환합니다. -
maxAdmin
변수의 값을 반환합니다.
getRestrictedStadium
getRestrictedStadium(void) : int
- 고정된 맵의 인덱스를 반환하는 메서드입니다.
-
lockStadium[0]
의 값을 반환합니다.
setDynamicAdmin
setDynamicAdmin(bool : bool)
- 권한 할당 방식을 지정하는 메서드입니다.
-
dynamicAdmin
과bool
의 값이 동일한 경우, 처리를 중단하고 반환합니다. -
dynamicAdmin
변수의 값을 변경합니다.
setKick
setKick(kickedPlayer : PlayerObject.id, msg : string, ban : bool) : bool
- 플레이어의 강제 퇴장을 처리하는 메서드입니다.
-
kickedPlayer
의 인자값은 플레이어의 공용 ID입니다. -
kickedPlayer
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다. - 플레이어 데이터베이스의
hasKicked
의 값을 변경합니다.
setPassword
setPassword(player : PlayerObject.id, pass : string) : bool
- 비밀번호 지정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
IoSystem
클래스의lockPass
변수의 값이true
인 경우, 처리를 중단하고 반환합니다. -
num
의 길이가 4 미만이거나 30 초과인 경우, 처리를 중단하고 반환합니다. -
updatePassword()
메서드를 호출합니다.
setPinHost
setPinHost(bool : bool)
- 방장 팀 이동 여부를 지정하는 메서드입니다.
-
NOPLAYER
의 값이true
이면, 처리를 중단하고 반환합니다.
setRestrictedStadium
setRestrictedStadium(index : index)
- 고정할 맵의 인덱스를 지정하는 메서드입니다.
-
lockStadium[0]
의 값을 변경합니다.
setScore
setScore(player : PlayerObject.id, num : string, type : bool)
- 점수 변경 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
type
의 값이1
인 경우, 도움말을 실행합니다. -
GameManager
클래스의gameStats
변수의 값이2
인 경우, 처리를 중단하고 반환합니다. -
num
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다.
setTeamsLock
setTeamsLock(bool : bool, player : PlayerObject.id) : bool
- 팀 이동 제한 여부를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
lockJoin
변수의 값을 변경합니다.
setTime
setTime(player : PlayerObject.id, num : string, type : bool)
- 시간 변경 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
type
의 값이1
인 경우, 도움말을 실행합니다. -
GameManager
클래스의gameStats
변수의 값이2
인 경우, 처리를 중단하고 반환합니다. -
num
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다.
addBlacklist
addBlacklist(index : PlayerObject.id)
- 블랙리스트를 추가하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. - 데이터베이스 초기화를 위해
initBlacklist()
메서드를 호출합니다.
addSuperBlacklist
addSuperBlacklist(index : PlayerObject.id)
- 슈퍼 블랙리스트를 추가하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. - 데이터베이스 초기화를 위해
initBlacklist()
메서드를 호출합니다.
updateAdmins
updateAdmins(player : PlayerObject)
- 권한을 갱신하는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. - 접속자가 없는 경우, 처리를 중단하고 반환합니다.
- 권한을 가진 접속자가 이미 있는 경우, 처리를 중단하고 반환합니다.
-
dynamicAdmin
변수의 값이false
인 경우, 처리를 중단하고 반환합니다. - 블랙리스트에 포함되거나 플레이어 데이터베이스의
isSleep
값이true
인 경우, 보조 권한을 부여합니다.
updatePassword
updatePassword(pass : string) : string
- 비밀번호를 갱신하는 메서드입니다.
- 서버의 비밀번호 고정 여부를 위해
IoSystem
클래스의isLockPass()
메서드를 호출합니다. -
PASSWORD
변수의 값으로 반환합니다.
clearBans
clearBans(player : PlayerObject.id) : bool
- 영구 퇴장 명단을 초기화하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
clearPassword
clearPassword(player : PlayerObject.id) : bool
- 비밀번호 해제 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
updatePassword()
메서드를 호출합니다.
deleteAdmin
deleteAdmin(player : PlayerObject.id)
- 플레이어의 최고 권한을 해제하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
deleteSubAdmin
deleteSubAdmin(player : PlayerObject.id)
- 플레이어의 보조 권한을 해제하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 플레이어 데이터베이스의
sub_admin
값을 변경합니다. - 최고 권한이 있는 경우, 처리를 중단하고 반환합니다.
resetGame
resetGame(player : PlayerObject.id) : bool
- 경기 재시작 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
showPassword
showPassword(player : PlayerObject.id) : string
- 비밀번호 출력 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
cntAdmins
cntAdmins(type : int) : int
- 권한을 가진 접속자 현재 인원을 계산하는 메서드입니다.
- 플레이어의 권한 여부를 확인하기 위해
getAdmin()
메서드를 호출합니다. -
type
의 값이0
인 경우, 권한을 가진 접속자의 현재 인원을 계산하여 반환합니다. -
type
의 값이1
인 경우, 최고 권한을 가진 접속자의 현재 인원을 계산하여 반환합니다. -
type
의 값이2
인 경우, 보조 권한을 가진 접속자의 현재 인원을 계산하여 반환합니다.
filterPlayer
filterPlayer(player : PlayerObject.id) : bool
- 사칭 및 중복 접속을 판정하고 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 플레이어가 접속해 있는 경우, 처리를 중단하고 반환합니다.
- 블랙리스트로 감지된 경우,
true
의 값으로 반환합니다. - 접속자 인원이 1명 이하인 경우, 처리를 중단하고 반환합니다.
- 유효하지 않은 공용 ID가 감지된 접속자가 있는 경우, 처리를 중단하고 오류를 전송합니다.
- 이름과 공용 네트워크가 동일한 경우, 중복 접속으로 판정하고
setKick()
메서드를 호출한 뒤true
의 값으로 반환합니다. - 공용 주소가 동일한 경우, 다중 접속으로 판명하고
addBlacklist()
및setKick()
메서드를 호출한 뒤true
의 값으로 반환합니다.
giveAdmin
giveSubAdmin(player : PlayerObject.id) : bool
- 플레이어의 최고 권한을 부여하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 최고 권한을 가진 접속자가
maxAdmin
변수의 값보다 크거나 같은 경우, 처리를 중단하고 반환합니다.
giveSubAdmin
giveSubAdmin(player : PlayerObject.id) : bool
- 플레이어의 보조 권한을 부여하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 보조 권한이 있는 경우, 처리를 중단하고 반환합니다.
- 보조 권한을 가진 접속자가
maxAdmin
변수 값의 2배인 수보다 크거나 같은 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
sub_admin
값을 변경합니다. - 플레이어 데이터베이스의
admin
값을 변경합니다. - 그래픽 유저 인터페이스의 플레이어 데이터베이스 갱신을 위해,
IoSystem
클래스의updateListIndex()
메서드를 호출합니다.
missPassword
missPassword(player : PlayerObject.id) : bool
- 최고 권한 로그인 비밀번호 오입력 시 호출되는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
mutePlayer
mutePlayer(mutedPlayer : PlayerObject.id, byPlayer : PlayerObject.id)
- 플레이어의 채팅을 금지하는 메서드입니다.
-
mutedPlayer
의 인자값은 플레이어의 공용 ID입니다. -
byPlayer
의 인자값은 플레이어의 공용 ID입니다. -
mutePlayer
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
isMute
값이true
인 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
isMute
값을 변경합니다. - 그래픽 유저 인터페이스의 플레이어 데이터베이스 갱신을 위해,
IoSystem
클래스의updateListIndex()
메서드를 호출합니다.
lockStadium
lockStadium(bool : bool) : bool
- 맵을 변경 제한을 제어하는 메서드입니다.
-
maps
의 길이가 1 미만인 경우, 처리를 중단하고 오류를 전송합니다. -
lockStadium[1]
의 값과bool
의 값이 동일한 경우, 처리를 중단하고 반환합니다. -
lockStadium[1]
의 값을 변경합니다. - 변경 사항은 다음 맵 변경 이벤트부터 적용됩니다.
logonAdmin
logonAdmin(player : PlayerObject.id) : bool
- 최고 권한 로그인을 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 최고 권한이 있는 경우, 처리를 중단하고 반환합니다.
- 플레이어 데이터베이스의
isSleep
값을false
의 값으로 변경합니다. - 최고 권한을 부여하기 위해
giveAdmin()
메서드를 호출합니다.
swapGame
swapGame(player : PlayerObject.id) : bool
- 경기 시종 명령어를 관리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
GameManager
클래스의gameStats
변수의 값이0
인 경우, 경기를 시작합니다. -
GameManager
클래스의gameStats
변수의 값이1
인 경우, 경기를 종료합니다.
unmutePlayer
unmutePlayer(target : PlayerObject.id, byPlayer : PlayerObject.id)
- 플레이어의 채팅을 허용하는 메서드입니다.
-
target
의 인자값은 플레이어의 공용 ID입니다. -
byPlayer
의 인자값은 플레이어의 공용 ID입니다. - 플레이어 데이터베이스의
isMute
값이true
인 경우 처리를 중단하고false
의 값으로 반환합니다. - 플레이어 데이터베이스의
isMute
값을 변경합니다. - 그래픽 유저 인터페이스의 플레이어 데이터베이스 갱신을 위해,
IoSystem
클래스의updateListIndex()
메서드를 호출합니다. -
true
의 값으로 반환합니다.
Notification 클래스
- 알림 및 메시지를 관리하는 클래스입니다.
ICON
ICON : object
- 제목 아이콘 상수 객체입니다.
getColor
getColor(color : int | string) : color
- 색상 유형을 반환하는 메서드입니다.
-
color
의 값이 유효하지 않거나 찾을 수 없는 경우,"0xFFFFFF"
의 값으로 반환합니다.
getSound
getSound(sound : int | string) : int | string
- 소리 유형을 반환하는 메서드입니다.
-
sound
의 값이 유효하지 않거나 찾을 수 없는 경우,1
의 값으로 반환합니다.
getStyle
getStyle(style : int | string) : string
- 글꼴 유형을 반환하는 메서드입니다.
-
style
의 값이 유효하지 않거나 찾을 수 없는 경우,"normal"
의 값으로 반환합니다.
alretMsg
alretMsg(player : PlayerObject.id)
- 금지어 감지 메시지를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
player
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다. - 플레이어 데이터베이스의
detector
값을 변경합니다. - 플레이어 데이터베이스의
detector
값이ChatSystem
클래스의maxDetection
변수의 값보다 큰 경우,Administration
클래스의setKick()
메서드를 호출합니다. -
ChatSystem
클래스의detectorLevel
변수의 값이 0인 경우, 처리를 종료하고 반환합니다. -
ChatSystem
클래스의detectorLevel
변수의 값이 1인 경우, 처리를 종료하고 반환합니다. -
ChatSystem
클래스의detectorLevel
변수의 값이 5인 경우,Administration
클래스의mutePlayer()
메서드를 호출합니다. -
ChatSystem
클래스의detectorLevel
변수의 값이 3인 경우,Administration
클래스의setKick()
메서드를 반환합니다. -
ChatSystem
클래스의detectorLevel
변수의 값이 4인 경우,Administration
클래스의mutePlayer()
메서드를 호출합니다. -
ChatSystem
클래스의detectorLevel
변수의 값이 2인 경우, 메시지를 출력하고 반환합니다.
announce
announce(msg : string, target : PlayerObject.id, color : color, style : string, sound : int, delay : int)
- 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 글꼴 색상을 지정하기 위해
getColor()
메서드를 호출합니다. - 글꼴 유형을 지정하기 위해
getStyle()
메서드를 호출합니다. - 소리 유형을 지정하기 위해
getSound()
메서드를 호출합니다. -
delay
의 값이 있는 경우 메시지를 밀리초 단위로 지연 출력합니다.
extMsg
extMsg(title : string, content : string, target : PlayerObject.id, advCom : string, titleColor : color, contentColor : color, delay : int)
- 확장된 유니버셜 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
delay
의 값이 있는 경우 제목은delay
, 내용은delay
에서 1 밀리초를 더한 수만큼 지연 출력합니다. -
delay
의 값은 밀리초 단위로 전달됩니다. -
title
의 값이null
인 경우, 처리를 중단하고 반환합니다. -
announce()
메서드를 호출합니다.
uniMsg
uniMsg(title : string, content : string, target : PlayerObject.id, advCom : string, delay : int)
- 유니버셜 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
delay
의 값이 있는 경우 메시지를 지연 출력합니다. -
delay
의 값은 초 단위로 전달됩니다. -
extMsg()
메서드를 호출합니다.
acess
acess(target : PlayerObject.id, reason : string)
- 권한 요구 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
extMsg()
메서드를 호출합니다.
caution
caution(msg : string, target : PlayerObject.id, advCom : string)
- 주의 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
extMsg()
메서드를 호출합니다.
info
info(msg : string, target : PlayerObject.id, advCom : string)
- 정보 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
extMsg()
메서드를 호출합니다.
locked
locked(isLock : bool, msg : string, target : PlayerObject.id, advCom : string)
- 잠금 및 해제 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
extMsg()
메서드를 호출합니다.
msgCommand
msgCommand(title : string, content : string, target : PlayerObject.id, advCom : string)
- 명령어 목록 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
uniMsg()
메서드를 호출합니다.
notice
notice(msg : string, target : PlayerObject.id, advCom : string)
- 알림 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
uniMsg()
메서드를 호출합니다.
warning
warning(msg : string, target : PlayerObject.id, advCom : string)
- 경고 메시지를 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
extMsg()
메서드를 호출합니다.
ChatSystem 클래스
- 채팅 시스템 동작을 담당하는 클래스입니다.
detectorLevel
let detectorLevel : int
- 금지어 엄격도 단계를 저장하는 변수입니다.
emotions
let emotions : []object
- 감정을 저장하는 배열입니다.
forbiddenWords
let forbiddenWords : []object
- 금지어를 저장하는 배열입니다.
isFreeze
let isFreeze : bool
- 채팅 얼림 여부를 저장하는 변수입니다.
maxDetection
let maxDetection : int
- 금지어 최대 감지량을 저장하는 변수입니다.
onPlayerChat
onPlayerChat(player : PlayerObject, msg : string)
- 플레이어의 채팅 입력 직후 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. - 플레이어의 마지막 활동 시간을 저장하기 위해
Player
클래스의updateTime()
메서드를 호출합니다. - 게임 미진행 중, 장기 무응답 플레이어 판정을 위해
GameManger
클래스의checkAfkPlayer()
메서드를 호출합니다. - 명령어 입력이 감지되면 기능 실행을 위해
GameManger
클래스의runCommand()
메서드를 호출합니다. -
isFreeze
변수의 값이true
인 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
isMute
값이true
인 경우, 처리를 중단하고 반환합니다.
isFreeze
isFreeze(player : PlayerObject.id, msg : string) : bool
- 채팅 얼림 여부를 반환하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
player
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고isFreeze
의 값으로 반환합니다. - 플레이어의 권한이 있거나
isFreeze
변수의 값이false
인 경우, 처리를 중단하고 반환합니다.
hasSpace
hasSpace(str : string) : bool
- 공백 포함 여부를 반환하는 메서드입니다.
- 공백 외 다른 문자가 감지된 경우,
false
의 값으로 반환합니다. - 공백 외 다른 문자가 없는 경우,
true
의 값으로 반환합니다.
getChatMode
getChatMode(player : PlayerObject.id) : int
-
플레이어 데이터베이스의
chatmode`를 반환하는 메서드입니다. -
player
의 인자값은 플레이어의 공용 ID입니다.
getDetectorLev
getDetectorLev(void) : int
- 금지어 엄격도 단계를 반환하는 메서드입니다.
-
detectorLevel
변수의 값으로 반환합니다.
getEmotion
getEmotion(index : int) : string
-
emotions
의 원소 값을 반환하는 메서드입니다. -
index
의 값이 부적절한 경우,0
의 값으로 반환합니다.
getForbiddenWord
getForbiddenWord(index : int) : string
- 금지어 단어를 반환하는 메서드입니다.
-
index
의 값이 부적절한 경우,0
의 값으로 반환합니다. -
forbiddenWords
의 원소 값으로 반환합니다.
getMaxDetection
getMaxDetection(void) : int
- 금지어 최대 감지량을 반환하는 메서드입니다.
-
maxDetection
변수의 값으로 반환합니다.
setChatMode
setChatMode(player : PlayerObject.id, msg : string)
- 채팅 입력 모드를 변경하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
chatmode
의 값을 변경합니다.
setAllChat
setAllChat(player : PlayerObject.id, msg : string, type : bool)
- 전체 채팅을 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이 1인 경우, 도움말을 실행합니다. -
sendAllChat()
메서드를 호출합니다.
setChatMode
setChatMode(player : PlayerObject.id, msg : string)
- 채팅 입력 모드를 변경하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
chatmode
의 값을 변경합니다.
setDetectorLev
setDetectorLev(lev : int) : bool
- 금지어 엄격도 단계를 지정하는 메서드입니다.
-
lev
의 값이 부적절하거나detectorLevel
변수의 값과 동일한 경우, 처리를 중단하고 반환합니다.
-
detectorLevel
변수의 값을 변경합니다.
setDisruptMode
setDisruptMode(player : PlayerObject.id, msg : string)
- 채팅 수신 모드를 변경하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
isDisrupt
의 값을 변경합니다.
setMaxDection
setMaxDection(limit : int)
- 금지어 최대 감지량 지정하는 메서드입니다.
-
limit
의 값이 부적절하거나maxDetection
변수의 값과 동일한 경우, 처리를 중단하고 반환합니다.
-
maxDetection
변수의 값을 변경합니다.
setTeamChat
setTeamChat(player : PlayerObject.id, msg : string, type : bool)
- 팀 채팅을 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
sendTeamChat()
메서드를 호출합니다.
setWhisperChat
setWhisperChat(player : PlayerObject.id, msg : string, type : bool)
- 귓속말 채팅을 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. - 플레이어 데이터베이스의
isDisrupt
값이true
인 경우, 처리를 중단하고 반환합니다. -
sendWhisperChat()
메서드를 호출합니다.
filterWords
filterWords(msg : string) : bool
- 금지어 필터링을 처리하는 메서드입니다.
-
detectorLevel
변수의 값이0
인 경우, 처리를 중단하고 반환합니다. -
forbiddenWords
에 일치하는 단어가 있는 경우,true
의 값으로 반환합니다.
freezeChat
freezeChat(bool : bool) : bool
- 채팅을 얼리거나 녹이는 메서드입니다.
-
isFreeze
변수의 값을 변경합니다. -
isFreeze
변수의 값으로 반환합니다.
sendAllChat
sendAllChat(player : PlayerObject.id, msg : string)
- 전체 채팅을 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 금지어 필터링을 위해
filterWords()
메서드를 호출합니다. -
isFreeze
변수의 값이true
인 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
isMute
값이true
인 경우, 처리를 중단하고 반환합니다. -
sendMsg()
메서드를 호출합니다.
sendEmojiChat
sendEmojiChat(player : PlayerObject.id, msg : string) : bool
- 감정 채팅을 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
sendMsg
sendMsg(msg : string, target : PlayerObject.id)
- 일반 메시지를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
NOPLAYER
의 값이true
이면Notification
클래스의announce()
메서드를 호출합니다.
sendTeamChat
sendTeamChat(teamId : teamId, player : PlayerObject.id, msg : string)
- 팀 채팅을 전송하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
teamId
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다. - 금지어 필터링을 위해
filterWords()
메서드를 호출합니다. -
isFreeze
변수의 값이true
인 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
isMute
값이true
인 경우, 처리를 중단하고 반환합니다. -
sendMsg()
메서드를 호출합니다.
sendWhisperChat
sendWhisperChat(toPlayer : PlayerObject.id, fromPlayer : PlayerObject.id, msg : string)
- 귓속말 채팅을 전송하는 메서드입니다.
-
toPlayer
의 인자값은 플레이어의 공용 ID입니다. -
fromPlayer
의 인자값은 플레이어의 공용 ID입니다. -
toPlayer
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다. - 금지어 필터링을 위해
filterWords()
메서드를 호출합니다. -
isFreeze
변수의 값이true
인 경우, 처리를 중단하고 반환합니다. - 플레이어 데이터베이스의
isMute
값이true
인 경우, 처리를 중단하고 반환합니다. -
sendMsg()
메서드를 호출합니다.
Commands 클래스
- 명령어 동작을 담당하는 클래스입니다.
setTeamColors
setTeamColors(player : PlayerObject.id, msg : string, type : bool) : bool
- 팀 유니폼 지정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. -
Player
클래스의setTeamColors()
메서드를 호출합니다.
alertSpam
alertSpam(player : PlayerObject.id, msg : string, type : bool) : bool
- 도배 방지 문자를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우,
helpCom()
메서드를 호출합니다.
comChatMode
comChatMode(player : PlayerObject.id, msg : string, type : bool) : bool
- 채팅 모드 설정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
ChatSystem
클래스의setChatMode()
메서드를 호출합니다.
comClearBans
comClearBans(player : PlayerObject.id)
- 채팅 금지 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
Administration
클래스의clearBans()
메서드를 호출합니다.
comClearTeamColors
comClearTeamColors(player : PlayerObject.id, index : string, type : bool) : bool
- 유니폼 초기화 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
index
의 값이 부적절한 경우, 처리를 중단하고 반환합니다. -
Player
클래스의clearTeamColors()
메서드를 호출합니다.
comDisruptMode
comDisruptMode(player : PlayerObject.id, msg : string, type : bool) : bool
- 채팅 수신 설정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
ChatSystem
클래스의setDisruptMode()
메서드를 호출합니다.
comFreezeChat
comFreezeChat(player : PlayerObject.id) : bool
- 채팅을 얼리는 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
ChatSystem
클래스의isFreeze
변수의 값이true
인 경우, 처리를 중단하고 반환합니다. - 현재 접속자 수가 3명 미만인 경우, 처리를 중단하고 반환합니다.
-
ChatSystem
클래스의freezeChat()
메서드를 호출합니다.
comKick
comKick(player : PlayerObject.id, msg : string, type : bool) : bool
- 채팅 금지 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
type
의 값이1
인 경우, 도움말을 실행합니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. -
Administration
클래스의setKick()
메서드를 호출합니다.
comMute
comMute(player : PlayerObject.id, msg : string, type : bool) : bool
- 채팅 금지 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
type
의 값이1
인 경우, 도움말을 실행합니다. - 현재 접속자 수가 2명 미만인 경우, 처리를 중단하고 반환합니다.
-
msg
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 반환합니다. -
Administration
클래스의mutePlayer()
메서드를 호출합니다.
comPinHost
comPinHost(player : PlayerObject.id) : bool
- 방장 이동 설정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
PLAYER
상수의 값이true
인 경우, 처리를 중단하고 반환합니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
Player
클래스의setTeam()
메서드를 호출합니다. -
Administration
클래스의setPinHost()
메서드를 호출합니다.
comRecording
comRecording(player : PlayerObject.id) : bool
- 녹화 설정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
GameManager
클래스의isRecording
변수의 값이true
인 경우,stopRecording()
메서드를 호출합니다. -
GameManager
클래스의isRecording
변수의 값이false
인 경우,startRecording()
메서드를 호출합니다.
(리비전 6~)comRecaptcha
comRecaptcha(player : PlayerObject.id, msg : string, type : bool) : bool
- reCAPTCHA 설정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이 1인 경우, 도움말을 실행합니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
- reCAPTCHA 적용 값을 반영하기 위해
IoSystem
클래스의setRequireRecaptcha()
메서드를 호출합니다.
comSleep
comSleep(player : PlayerObject.id) : bool
- 팀 자율 이동 설정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
player
의 값이 부적절한 경우, 처리를 중단하고 반환합니다. -
Player
클래스의setSleep()
메서드를 호출합니다.
comTeamsLock
comTeamsLock(player : PlayerObject.id, msg : string, type : bool) : bool
- 팀 자율 이동 설정 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
type
의 값이1
인 경우, 도움말을 실행합니다. -
Administration
클래스의setTeamsLock()
메서드를 호출합니다.
comUnfreezeChat
comUnfreezeChat(player : PlayerObject.id) : bool
- 채팅을 녹이는 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
ChatSystem
클래스의isFreeze
변수의 값이false
인 경우, 처리를 중단하고 반환합니다. -
ChatSystem
클래스의freezeChat()
메서드를 호출합니다.
comUnmute
comUnmute(player : PlayerObject.id, msg : string, type : bool)
- 채팅 허용 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 없는 경우, 처리를 중단하고 반환합니다.
-
type
의 값이1
인 경우, 도움말을 실행합니다. -
msg
의 값이"all"
인 경우, 모든 플레이어의 채팅을 허용합니다. -
Administration
클래스의unmutePlayer()
메서드를 호출합니다.
helpBot
helpBot(player : PlayerObject.id) : bool
- 서버 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 있는 경우, 관리 명령어를 추가합니다.
-
Notification
클래스의msgCommand()
메서드를 호출합니다.
helpChat
helpChat(player : PlayerObject.id) : bool
- 채팅 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 있는 경우, 관리 명령어를 추가합니다.
-
Notification
클래스의msgCommand()
메서드를 호출합니다.
helpCom
helpCom(player : PlayerObject.id) : bool
- 명령어 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 있는 경우, 관리 명령어를 추가합니다.
-
Notification
클래스의msgCommand()
메서드를 호출합니다.
helpJoin
helpJoin(player : PlayerObject.id) : bool
- 참가 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 있는 경우, 관리 명령어를 추가합니다.
-
Notification
클래스의msgCommand()
메서드를 호출합니다.
helpMap
helpMap(player : PlayerObject.id) : bool
- 맵 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 있는 경우, 관리 명령어를 추가합니다.
-
Notification
클래스의msgCommand()
메서드를 호출합니다.
helpMisc
helpMisc(player : PlayerObject.id) : bool
- 기타 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 있는 경우, 관리 명령어를 추가합니다.
-
Notification
클래스의msgCommand()
메서드를 호출합니다.
helpRank
helpRank(player : PlayerObject.id) : bool
- 랭크 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 권한이 있는 경우, 관리 명령어를 추가합니다.
-
Notification
클래스의msgCommand()
메서드를 호출합니다.
helpScore
helpScore(player : PlayerObject.id) : bool
- 점수 도움말을 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
infoMaps
infoMaps(player : PlayerObject.id, msg : string) : bool
- 서버에 저장된 맵 목록 정보를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
GameManager
클래스의updateStadiumsData()
메서드를 호출합니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 0~4번째 인덱스의 맵 정보를 출력합니다.
infoRanking
infoRanking(player : PlayerObject.id, index : string, type : bool) : bool
- 랭킹 정보를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
index
의 값이 부적절하거나 찾을 수 없는 경우, 플레이어의 랭킹 정보를 출력합니다.
infoRoom
infoRoom(player : PlayerObject.id) : bool
- 서버 정보를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 릴리스 일자를 포합니다.
-
IoSystem
클래스의showInfo()
메서드를 호출합니다. (이 구문은 임의로 수정하거나 지우지 마십시오.)
infoStats
infoStats(player : PlayerObject.id, msg : string, type : bool) : bool
- 플레이어의 점수 정보를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 플레이어의 점수 정보를 출력합니다.
joinGame
joinGame(player : PlayerObject.id, msg : string, type : bool) : bool
- 플레이어를 투입 명령어를 처리하는 메서드입니다.
-
player
의 인자값은 투입되는 플레이어의 공용 ID입니다. -
type
의 값이1
인 경우, 도움말을 실행합니다. - 플레이어의 권한이 있는 경우, 추가 명령문을 입력받아
comTeamsLock()
메서드를 호출합니다. - 플레이어의 권한이 있는 경우, 추가 명령문을 입력받아 다른 플레어어를 투입합니다.
-
joinPlayer()
메서드를 호출합니다. -
msg
의 값이 부적절하거나 찾을 수 없는 경우, 인원을 계산하여 적절한 팀으로 투입합니다.
joinPlayer
joinPlayer(player : PlayerObject.id, team : teamId, byPlayer : PlayerObject.id) : bool
- 플레이어를 투입하는 메서드입니다.
-
player
의 인자값은 명령어를 입력한 플레이어의 공용 ID입니다. -
byPlayer
의 인자값은 투입하는 플레이어의 공용 ID입니다. -
Administration
클래스의lockJoin
변수의 값이true
인 경우, 처리를 중단하고 반환합니다. -
team
의 값이 플레이어의 현재 팀과 동일한 경우, 처리를 중단하고 반환합니다. - 장기 대기열 명단에 포함된 경우, 처리를 중단하고 반환합니다.
loadMap
loadMap(player : PlayerObject.id, msg : string)
- 서버에 저장된 맵을 불러오는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
Player 클래스
- 게임 플레이어와 관련된 클래스입니다.
addressList
let addressList : []object
- 플레이어의 공용 네트워크를 저장하는 배열입니다.
gradeTag
let gradeTag : []object
- 권한 마크를 저장하는 배열입니다.
networkList
let networkList : []object
- 플레이어의 공용 네트워크를 저장하는 배열입니다.
playerList
let playerList : []object
- 플레이어의 데이터베이스를 저장하는 객체입니다.
teamTag
let teamTag : []object
- 팀 마크를 저장하는 배열입니다.
onPlayerActivity
onPlayerActivity(player : PlayerObject)
- 플레이어 동작에 응답이 있을 때 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. - 플레이어의 마지막 응답 시간을 저장합니다.
onPlayerTeamChange
onPlayerTeamChange(player : PlayerObject, byPlayer : PlayerObject)
- 플레이어의 팀 변경이 감지되면 호출되는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다. -
player
의 값이 0인 경우 처리르 중단하고 반환합니다. -
IoSystem
클래스의clearListIndex()
메서드를 호출합니다. - 플레이어의 마지막 응답 시간을 저장합니다.
- 플레이어 데이터베이스의
team
의 값을 변경합니다. -
IoSystem
클래스의addListIndex()
메서드를 호출합니다.
onPlayerInactivity
onPlayerInactivity(player : PlayerObject.id)
- 플레이어 동작에 장시간 응답이 없을 때 호출되는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
initPlayerList
initPlayerList(data : PlayerObject)
- 플레이어 데이터베이스를 초기화 하는 메서드입니다.
-
data
의 인자값은 플레이어 객체입니다.
isValid
isValid(index : PlayerObject.id) : bool
- 유효 플레이어를 식별하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. -
index
의 값이 유효한 경우true
를, 그렇지 않는 경우false
를 반환합니다.
getAddress
getAddress(index : PlayerObject.id) : double
- 플레이어의 공용 주소를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getGravityX
getGravityX(index : PlayerObject.id) : DiscPropertiesObject.xgravity
- 플레이어의 X 중력을 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getGravityY
getGravityY(index : PlayerObject.id) : DiscPropertiesObject.ygravity
- 플레이어의 Y 중력을 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getBcoeff
getBcoeff(index : PlayerObject.id) : DiscPropertiesObject.bcoeff
- 플레이어의 바운스를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getDamping
getDamping(index : PlayerObject.id) : DiscPropertiesObject.damping
- 플레이어의 제동을 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getGradeTag
getGradeTag(player : PlayerObject.id) : string
- 플레이어의 권한 마크를 반환하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
player
의 값이 부적절한 경우, 처리를 중단하고 오류를 전송합니다.
getInvMass
getInvMass(index : PlayerObject.id) : DiscPropertiesObject.invMass
- 플레이어의 역질량을 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getRadius
getRadius(index : PlayerObject.id) : DiscPropertiesObject.radius
- 플레이어의 반지름을 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getLocalId
getLocalId(publicId : PlayerObject.id) : int
- 플레이어의 개인 ID를 반환하는 메서드입니다.
-
publicId
의 인자값은 플레이어의 공용 ID입니다. - 해당 플레이어가 현재 미접속 중인 경우,
false
를 반환합니다.
getNetwork
getNetwork(index : PlayerObject.id) : double
- 플레이어의 공용 네트워크를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. - 반환될 값이 부적절한 경우, 처리를 중단하고 오류를 전송합니다.
getPlayer
getPlayer(index : PlayerObject.id) : playerList
- 플레이어 데이터베이스를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. -
index
의 값이 부적절한 경우, 처리를 중단하고 오류를 전송합니다.
getPlayerDiscProp
getPlayerDiscProp(index : PlayerObject.id) : DiscPropertiesObject
- 플레이어의 객체 속성을 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getPostion
getPostion(index : PlayerObject.id) : vector2D
- 플레이어의 좌표를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getPosX
getPosX(index : PlayerObject.id) : DiscPropertiesObject.x
- 플레이어의 X 좌표를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getPosY
getPosY(index : PlayerObject.id) : DiscPropertiesObject.y
- 플레이어의 Y 좌표를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getPublicId
getPublicId(privateId : int) : int
- 플레이어의 공용 ID를 반환하는 메서드입니다.
-
privateId
의 인자값은 플레이어의 개인 ID입니다.
getSpeedX
getSpeedX(index : PlayerObject.id) : DiscPropertiesObject.xspeed
- 플레이어의 X 속도를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getSpeedY
getSpeedY(index : PlayerObject.id) : DiscPropertiesObject.yspeed
- 플레이어의 Y 속도를 반환하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getTeamTag
getTeamTag(team : teamId, type : bool) : string
- 팀 마크를 반환하는 메서드입니다.
-
type
의 값이true
이면gradeTag
의 0번째 인덱스를 반환합니다. -
team
의 값이 부적절하거나 찾을 수 없는 경우, 처리를 중단하고 오류를 전송합니다.
setAddress
setAddress(player : PlayerObject.id, addrs : double) : bool
- 플레이어의 공용 주소를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setAvatar
setAvatar(player : PlayerObject.id, msg : string) : bool
- 플레이어의 등번호를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setBcoeff
setBcoeff(player : PlayerObject.id, scale : double)
- 플레이어의 바운스를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setDamping
setDamping(player : PlayerObject.id, scale : double)
- 플레이어의 제동을 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setGravityX
setGravityX(player : PlayerObject.id, scale : double)
- 플레이어의 X 중력을 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setGravityY
setGravityY(player : PlayerObject.id, scale : double)
- 플레이어의 Y 중력을 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setInvMass
setInvMass(player : PlayerObject.id, amount : double)
- 플레이어의 역질량을 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setNetwork
setNetwork(player : PlayerObject.id, net : double) : bool
- 플레이어의 공용 네트워크를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setPlayer
setPlayer(player : PlayerObject.id, index : object, value : object)
- 플레이어의 데이터베이스를 수정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
index
의 값이 부적절한 경우, 처리를 중단하고 오류를 전송합니다.
setPostion
setPostion(player : PlayerObject.id, x : double, y : double)
- 플레이어의 좌표를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setPosX
setPosX(player : PlayerObject.id, pos : double)
- 플레이어의 X 좌표를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setPosY
setPosY(player : PlayerObject.id, pos : double)
- 플레이어의 Y 좌표를 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setRadius
setRadius(player : PlayerObject.id, len : double)
- 플레이어의 반지름을 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
setSleep
setSleep(player : PlayerObject.id, bool : bool)
- 장기 대기열 플레이어를 설정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
bool
의 값이true
이면addSleepPlayer()
메서드를 호출합니다. -
bool
의 값이false
이면deleteSleepPlayer()
메서드를 호출합니다. - 그래픽 유저 인터페이스의 플레이어 데이터베이스 갱신을 위해,
IoSystem
클래스의updateListIndex()
메서드를 호출합니다.
setTeam
setTeam(player : PlayerObject.id, team : teamID) : void
- 플레이어의 팀을 지정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
team
의 값이 부적절한 경우, 처리를 중단하고 오류를 전송합니다.
setTeamColors
setTeamColors(team : teamID, angle : int, textColor : color, bgColor : color)
- 팀 유니폼을 지정하는 메서드입니다.
addSleepPlayer
addSleepPlayer(player : PlayerObject.id)
- 장기 대기열 플레이어를 추가하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 플레이어의 팀이 관중이 아닐 경우, 관중석으로 이동합니다.
- 최고 권한을 가진 경우, 보조 권한으로 격하합니다.
updateAccount
updateAccount(player : PlayerObject.id) : bool
- 계정 데이터베이스를 갱신하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
updateTime
updateTime(player : PlayerObject.id)
- 플레이어의 응답 시간을 갱신하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
clearPlayerList
clearPlayerList(data : PlayerObject)
- 플레이어 데이터베이스를 제거하는 메서드입니다.
-
data
의 인자값은 플레이어 객체입니다. -
IoSystem
클래스의clearListIndex()
메서드를 호출합니다.
clearTeamColors
clearTeamColors(team : teamID)
- 팀 유니폼을 초기화 하는 메서드입니다.
deleteSleepPlayer
deleteSleepPlayer(player : PlayerObject.id)
- 장기 대기열 플레이어를 제거하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
resetAvatar
resetAvatar(player : PlayerObject.id) : bool
- 등번호를 초기화 하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
cntPlayers
cntPlayers(team : string) : int
- 플레이어 인원을 계산하는 메서드입니다.
-
team
의 값이"public"
인 경우, 누적 접속자 인원을 반환합니다. -
team
의 값이null
인 경우, 현재 접속자 인원을 반환합니다. -
team
의 값이 팀 ID인 경우, 개별 팀의 접속 인원을 반환합니다.
Scores 클래스
- 랭킹 및 전적 시스템의 작동 기반 클래스입니다.
m_SCORE_TYPE
const m_SCORE_TYPE : object
- 점수 인덱스 상수 객체입니다.
- 클래스 외부에서 접근할 수 없습니다.
SCORE_TYPE
SCORE_TYPE : object
- 점수 인덱스 상수 객체입니다.
-
m_SCORE_TYPE
을 반환합니다.
collisionRange
let collisionRange : float
- 충돌 범위 민감도를 저장하는 변수입니다.
rankList
let rankList : []object
- 랭킹 명단을 저장하는 배열입니다.
statsList
let statsList : []object
- 플레어어의 전적 데이터베이스를 저장하는 객체입니다.
totalRedGoals
let totalRedGoals : int
- 레드팀의 누적 골 개수를 저장하는 변수입니다.
totalBlueGoals
let totalBlueGoals : int
- 블루팀의 누적 골 개수를 저장하는 변수입니다.
tochedList
let tochedList : []object
- 선두자 데이터베이스를 저장하는 객체입니다.
initRanking
initRanking(player : PlayerObject.id) : void
- 플레이어의 랭킹을 초기화 하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
initStatsList
initStatsList(player : PlayerObject.id) : void
- 플레이어의 점수 데이터베이스를 초기화 하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
initTouchedList
initTouchedList(player : PlayerObject.id) : void
- 선두자의 데이터베이스를 초기화 하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
getAssist
getAssist(index : int) : object | int
- 어시스트를 구하는 메서드입니다.
-
index
는tochedList
의 인덱스입니다. -
tochedList
의 길이가 2 미만인 경우, 처리를 중단하고 반환합니다. - 팀원의 수가 2명 미만인 경우, 처리를 중단하고 반환합니다.
getCurrentGoals
getCurrentGoals(void) : int
- 현재 득점 골의 수치를 반환하는 메서드입니다.
-
GameManager
클래스의getGamsStats()
메서드를 호출합니다. - 경기가 진행 중이 아닐 경우,
null
의 값으로 반환합니다.
getCollRange
getCollRange(void) : float
- 충돌 범위 민감도를 반환하는 메서드입니다.
-
collisionRange
변수의 값이 1 미만인 경우, 1의 값으로 반환합니다. -
collisionRange
변수의 값으로 반환합니다.
getDisc
getDisc(index : DiscPropertiesObject.id) : DiscPropertiesObject
- 디스크의 객체를 반환하는 메서드입니다.
getDiscBcoeff
getDiscBcoeff(index : DiscPropertiesObject.id) : DiscPropertiesObject.bCoeff
- 디스크의 바운스의 값을 반환하는 메서드입니다.
getDiscColor
getDiscColor(index : DiscPropertiesObject.id) : DiscPropertiesObject.color
- 디스크의 색상을 반환하는 메서드입니다.
- 반환 값을 16진수로 변환합니다.
getDiscColMask
getDiscColMask(index : DiscPropertiesObject.id) : DiscPropertiesObject.cMask
- 디스크의 충돌 마스크를 반환하는 메서드입니다.
getDiscColGroup
getDiscColGroup(index : DiscPropertiesObject.id) : DiscPropertiesObject.cGroup
- 디스크의 충돌 그룹을 반환하는 메서드입니다.
getDiscDamping
getDiscDamping(index : DiscPropertiesObject.id) : DiscPropertiesObject.damping
- 디스크의 제동 값을 반환하는 메서드입니다.
getDiscGravityX
getDiscGravityX(index : DiscPropertiesObject.id) : DiscPropertiesObject.xgravity
- 디스크의 x 중력 값을 반환하는 메서드입니다.
getDiscGravityY
getDiscGravityY(index : DiscPropertiesObject.id) : DiscPropertiesObject.ygravity
- 디스크의 y 중력 값을 반환하는 메서드입니다.
getDiscInvMass
getDiscInvMass(index : DiscPropertiesObject.id) : DiscPropertiesObject.invMass
- 디스크의 역질량의 값을 반환하는 메서드입니다.
getDiscPostion
getDiscPosition(index : DiscPropertiesObject.id) : vector2D
- 디스크의 좌표 값을 반환하는 메서드입니다.
- x, y 좌표를 벡터 값으로 반환합니다.
getDiscPosX
getDiscPosX(index : DiscPropertiesObject.id) : DiscPropertiesObject.x
- 디스크의 x 좌표의 값을 반환하는 메서드입니다.
getDiscPosY
getDiscPosY(index : DiscPropertiesObject.id) : DiscPropertiesObject.y
- 디스크의 y 좌표의 값을 반환하는 메서드입니다.
getDiscSpeedX
getDiscSpeedX(index : DiscPropertiesObject.id) : DiscPropertiesObject.xspeed
- 디스크의 x 속도의 값을 반환하는 메서드입니다.
getDiscSpeedY
getDiscSpeedY(index : DiscPropertiesObject.id) : DiscPropertiesObject.yspeed
- 디스크의 y 속도의 값을 반환하는 메서드입니다.
getDiscRadius
getDiscRadius(index : DiscPropertiesObject.id) : DiscPropertiesObject.radius
- 디스크의 반지름의 값을 반환하는 메서드입니다.
getDistance
getDistance(a : DiscPropertiesObject, b : DiscPropertiesObject) : double
- 두 객체 간의 거리를 계산하여 반환하는 메서드입니다.
getGameTime
getGameTime(void) : ScoresObject.time
- 현재 경기 시간을 반환하는 메서드입니다.
getLastTouchedPlayer
getLastTouchedPlayer(void) : object
- 최근 선두자를 구하는 메서드입니다.
-
tochedList
의 0번째 인덱스를 반환합니다. -
tochedList
의 길이가 0인 경우,null
의 값으로 반환합니다.
getPlayerScores
getPlayerScores(player : PlayerObject) : int
- 플레어어 전적을 계산하여 점수의 총합을 반환하는 메서드입니다.
-
player
의 인자값은 플레이어 객체입니다.
getRankList
getRankList(void) : []object
- 랭킹 명단을 반환하는 메서드입니다.
getRanking
getRanking(player : PlayerObject.id) : int
- 랭킹 등수를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. - 플레이어의 전적 데이터베이스가 없는 경우
false
의 값으로 반환합니다.
getStatsList
getStatsList(index : PlayerObject.id) : statsList
- 전적 데이터베이스를 구하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
getTotalGoals
getTotalGoals(scale : float) : object
- 랭킹 메시지를 출력하는 메서드입니다.
getTouchedList
getTouchedList(void) : void
- 선두자 명단을 반환하는 메서드입니다.
getWinner
getWinner(scores : ScoresObject)
- 승리 팀을 판정하는 메서드입니다.
setCollRange
setCollRange(scale : float) : void
- 충돌 민감도 범위를 지정하는 메서드입니다.
setRanking
setRanking(rankIndex : int, playerIndex : PlayerObject.id) : void
- 랭킹을 지정하는 메서드입니다.
-
playerIndex
의 인자값은 플레이어의 공용 ID입니다.
addTouchedList
addTouchedList(index : PlayerObject.id)
- 선두자 데이터베이스를 추가하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다. -
initTouchedList()
메서드를 호출합니다.
updateGoals
updateGoals(team : teamID) : bool
- 득점 골을 갱신하는 메서드입니다.
-
GameManger
클래스의getGameStats()
메서드를 호출합니다.
updateRanking
updateRanking(void) : bool
- 랭킹을 갱신하는 메서드입니다.
updateStatsList
updateStatsList(player : PlayerObject.id, index : int, value : int)
- 전적 데이터베이스를 수정하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다. -
index
의 값이 부적절한 경우, 처리를 중단하고 오류를 전송합니다.
updateTouchedList
updateTouchedList(index : PlayerObject.id) : bool
- 선두자를 갱신하는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
cleaerStatsList
cleaerStatsList(data : PlayerObject.id) : object
- 전적 데이터베이스를 지우는 메서드입니다.
-
data
의 인자값은 플레이어의 공용 ID입니다. -
initStatsList()
를 반환합니다.
clearTouchedList
clearTouchedList(index : PlayerObject.id) : void
- 선두자의 데이터베이스를 지우는 메서드입니다.
-
index
의 인자값은 플레이어의 공용 ID입니다.
showPlayerStats
showPlayerStats(player : PlayerObject.id) : string
- 랭킹 메시지를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
showRankingStats
showRankingStats(player : PlayerObject.id) : string
- 플레이어의 점수 데이터베이스를 출력하는 메서드입니다.
-
player
의 인자값은 플레이어의 공용 ID입니다.
sendRanking
sendRanking(target : PlayerObject.id, player : PlayerObject.id) : bool
- 랭킹 메시지를 출력하는 메서드입니다.
-
target
의 인자값은 플레이어의 공용 ID입니다. -
player
의 인자값은 플레이어의 공용 ID입니다.
TimeManager 클래스
- 시간을 담당하는 클래스입니다.
m_TIME_TYPE
const m_TIME_TYPE : object
- 시간 출력 형식 상수 열거형입니다.
- 클래스 외부에서 접근할 수 없습니다.
TIME_TYPE
TIME_TYPE : object
- 시간 출력 형식 열거형입니다.
-
m_TIME_TYPE
을 반환합니다.
statsIndex
let statsIndex
- 현재 시간 출력 형식을 저장하는 변수입니다.
updateDate
let updateDate(void)
- 날짜를 갱신하는 메서드입니다.
updateTime
let updateTime(void)
- 시간을 갱신하는 메서드입니다.
- 1970년 1월 1일 0:00 기준에서 현재 시간을 뺀 나머지의 값을 ms 단위로 반환합니다.
showDate
let showDate(void)
- 날짜 및 시간을 출력하는 메서드입니다.
-
updateDate()
메서드를 호출합니다. -
showTimsg()
와showTime()
메서드를 호출합니다.
showNormalTime
let showNormalTime(void)
- 시간을 Windows 작업 표시줄 방식으로 출력하는 메서드입니다.
-
updateTime()
메서드를 호출합니다. -
optimizationTime()
메서드를 호출합니다.
showTime
let showTime(void)
- 시간을 출력하는 메서드입니다.
-
updateTime()
메서드를 호출합니다. -
optimizationTime()
메서드를 호출합니다.
optimizationTime
let optimizationTime(void)
- 최신 시간으로 갱신한 뒤, 교정된 값을 변수에 저장하는 메서드입니다.
getDate
getDate(void) : date
- 날짜 및 시간을 반환하는 메서드입니다.
-
updateDate()
메서드를 호출합니다.
getTime
getTime(void) : unsgined double
- 시간을 반환하는 메서드입니다.
-
updateTime()
메서드를 호출합니다.
setTimeType
setTimeType(index : TIME_TYPE) : bool
- 시간 출력 형식을 지정하는 메서드입니다.
-
TIME_TYPE
을 인자값으로, 매개변수인 index에 전달합니다. -
index
의 값에 만족하는 조건이 없는 경우 오류를 전송하고false
값으로 반환합니다. -
index
의 값에 만족하는 조건이면true
값으로 반환합니다.
showCurrentTime
showCurrentTime(index : m_TIME_TYPE) : string
- 현재 시간을 출력하는 메서드입니다.
-
index
의 값이 적절하지 않은 경우 오류를 전송합니다.
IoSystem 클래스
- 내부 시스템 또는 서버 초기화를 담당하는 클래스입니다.
m_ERROR_TYPE
const m_ERROR_TYPE : object
- 오류 타입 상수 열거형입니다.
- 클래스 외부에서 접근할 수 없습니다.
m_LOG_TYPE
const m_LOG_TYPE : object
- 로그 타입 상수 열거형입니다.
- 클래스 외부에서 접근할 수 없습니다.
DEV
const DEV : bool
- 개발자 버전을 식별하는 상수 변수입니다.
- 클래스 외부에서 접근할 수 없습니다.
addWebElement
const addWebElement(prtsEle : object, chldEle : object)
- 그래픽 유저 인터페이스에 자식 객체를 추가하는 상수 메서드입니다.
-
prtsEle
의 인자 값은 부모 객체입니다. -
chldEle
의 인자 값은 자식 객체입니다.
outputLogMsg
const outputLogMsg(msg : string, time : string, textColor : color, bgColor : color)
- 로그를 출력하는 상수 메서드입니다.
-
textColor
의 값에 따라 텍스트 색을 지정합니다. -
bgColor
의 값에 따라 배경 색을 지정합니다.
printMsg
const printMsg(msg : string, target : PlayerObject.id | teamID | string)
- 서버 메시지를 출력하는 상수 메서드입니다.
securityPatchLevel
const securityPatchLevel : secp_level
- UMUX 보안 패치 수준을 저장하는 변수입니다.
- 임의로 지우거나 수정하지 마십시오.
versionUMUX
const versionUMUX : umux_level
- UMUX 버전을 저장하는 변수입니다.
- 임의로 지우거나 수정하지 마십시오.
ERROR_TYPE
ERROR_TYPE : object
- 오류 타입 열거형입니다.
-
m_ERROR_TYPE
을 반환합니다.
LOG_TYPE
LOG_TYPE : object
- 로그 타입 열거형입니다.
-
m_LOG_TYPE
을 반환합니다.
versionRoom
let versionRoom : string
- 서버 버전을 저장하는 변수입니다.
hasInitServer
let hasInitServer : bool
- 서버의 초기화 상태를 저장하는 변수입니다.
hasInitWebGUI
let hasInitWebGUI : bool
- 그래픽 유저 인터페이스의 초기화 상태를 저장하는 변수입니다.
lockPass
let lockPass : bool
- 비밀번호 고정 상태가 저장된 변수입니다.
framebody
let framebody : object
- iframe 객체입니다.
defaultFontFamily
let defaultFontFamily : string
- 그래픽 유저 인터페이스의 기본 글꼴 집합입니다.
newLine
newLine : string
- 개행 문자입니다.
initWebGUI
initWebGUI(void) : bool
- 그래픽 유저 인터페이스를 초기화 하는 메서드입니다.
- 서버가 초기화 되지 않은 경우, 처리를 중단하고 반환합니다.
isDev
isDev(void) : bool
- 개발자 버전 여부를 반환하는 메서드입니다.
-
DEV
의 값으로 반환합니다.
isLockPass
isLockPass(void) : bool
- 서버의 비밀번호 고정 상태를 반환하는 메서드입니다.
-
lockPass
변수의 값으로 반환합니다.
getSecurityPatchLevel
getSecurityPatchLevel(void) : string
- UMUX 보안 패치 수준을 반환하는 메서드입니다.
- 임의로 지우거나 수정하지 마십시오.
getServer
getServer(void) : bool
- 서버의 초기화 상태를 반환하는 메서드입니다.
getVersionRoom
getVersionRoom(void) : string
- 서버 버전을 반환하는 메서드입니다.
getVersionUMUX
getVersionUMUX(void) : string
- UMUX 버전을 반환하는 메서드입니다.
- 임의로 지우거나 수정하지 마십시오.
setRequireRecaptcha
setRequireRecaptcha(isActive : bool)
- reCAPTCHA를 설정하는 메서드입니다.
setLine
setLine(amount : int, line : int) : string
- 숫자의 자릿수를 교정하는 메서드입니다.
addListIndex
addListIndex(player : PlayerObject.id) : bool
- 그래픽 유저 인터페이스의 플레이어 데이터베이스를 추가하는 메서드입니다.
-
player
의 인자 값은 플레이어의 공용 ID입니다. -
player
의 매개변수 값이 유효하지 않는 경우, 처리를 중단하고 오류를 전송합니다. - 플레이어의 개인 ID가 유효하지 않는 경우, 처리를 중단하고 오류를 전송합니다.
updateListIndex
updateListIndex(player : PlayerObject.id) : bool
- 그래픽 유저 인터페이스의 플레이어 데이터베이스를 갱신하는 메서드입니다.
-
player
의 인자 값은 플레이어의 공용 ID입니다. -
player
의 매개변수 값이 유효하지 않는 경우, 처리를 중단하고 오류를 전송합니다.
updateWebGUI
updateWebGUI(void) : bool
- 그래픽 유저 인터페이스를 갱신하는 메서드입니다.
clearListIndex
clearListIndex(player : PlayerObject.id) : bool
- 그래픽 유저 인터페이스의 플레이어 데이터베이스를 제거하는 메서드입니다.
-
player
의 인자 값은 플레이어의 공용 ID입니다. -
player
의 매개변수 값이 유효하지 않는 경우, 처리를 중단하고 오류를 전송합니다.
showInfo
showInfo(void) : string
- UMUX 저작물/버전을 출력하는 메서드입니다.
- 임의로 지우거나 수정하지 마십시오.
showPlayerInfo
showPlayerInfo(player : PlayerObject.id, type : string) : string
- 플레이어의 닉네임 및 ID를 출력하는 메서드입니다.
- 플레이어의 닉네임이 빈 문자열인 경우 유의미한 문자열로 임의 출력합니다.
-
player
의 인자 값은 플레이어의 공용 ID입니다. -
player
의 매개변수 값이 유효하지 않는 경우, 처리를 중단하고 오류를 전송합니다. -
type
의 값이null
인 경우, 플레이어의 공용 ID와 개인 ID, 그리고 닉네임을 반환합니다. -
type
의 값이"local"
인 경우, 플레이어의 개인 ID와 닉네임을 반환합니다. -
type
의 값이"public"
인 경우, 플레이어의 공용 ID와 닉네임을 반환합니다. -
type
의 값이"name"
인 경우, 플레이어의 닉네임을 반환합니다.
lockPassword
lockPassword(bool : bool)
- 서버 비밀번호를 고정하는 메서드입니다.
-
bool
의 값이true
이면 고정,false
일 경우 해제합니다.
log
log(io : bool, msg : string, type : m_LOG_TYPE)
- 로그를 전달하는 메서드입니다.
-
io
의 값이true
이면 출력,false
일 경우 입력 로그로 지정됩니다. -
m_LOG_TYPE
을 인자 값으로, 매개변수인type
에 전달합니다.
print(msg : string, target : PlayerObject.id | teamID | string)
- 서버 메시지를 출력하는 메서드입니다.
-
printMsg()
메서드를 호출합니다.
sendError
sendError(type : ERROR_TYPE)
- 오류를 출력하는 메서드입니다.
-
ERROR_TYPE
을 인자 값으로, 매개변수인type
에 전달합니다.
기타
TEAM
const TEAM : object
- 팀 ID를 저장하는 상수 열거형입니다.
c
const c(msg : string, target : PlayerObject.id | teamID | string)
- 로그 메시지를 입출력 하는 상수 메서드입니다.
-
IoSystem
클래스의print()
메서드를 호출합니다.
stopbot
const stopbot(void) : void
- 서버 연결을 일시 중단하는 상수 메서드입니다.
maps
var maps : []stadiumObject
- 시스템 내장 맵 데이터를 저장하는 객체 배열입니다.
internalCommands
const internalCommands []commandsObject
- UMUX 내부 시스템을 접근하는 명령어입니다.
- 기존 명령어 삭제 및 신규 명령어 추가는 금지합니다.
- 기존 명령어 접근을 막거나 주석 처리는 권장하지 않습니다.
standardCommands
const standardCommands []commandsObject
- UMUX 표준 명령어입니다.
- 기존 명령어 삭제 및 신규 명령어 추가는 권장하지 않습니다.
- 기존 명령어 접근을 막거나 주석 처리는 권장하지 않습니다.
customCommands
var customCommands []commandsObject
- UMUX 커스텀 명령어입니다.
- 신규 명령어 추가에 적합하며, 권장합니다.