개요

본 문서는 투자 미션의 모딩에 사용되는 스크립트 파일의 구조를 설명합니다.

주의 사항

해당 항목은 Mod scripting guide : Event와 중복되는 내용을 담고 있습니다. 스크립트 작성 시 주의해야 할 사항은 다음과 같습니다.

• 0000번 스크립트를 통해 확인 가능한 템플릿이 지켜져야 합니다.
• Lua에서 기본적으로 사용 가능한 라이브러리(math, string 등)를 사용할 수 있습니다.
• API는 적절한 용도에 맞게 사용되어야 합니다. (ex. Investment에서 Event의 API를 사용할 수 없습니다.)
• 같은 카테고리 내 스크립트 파일의 전역변수는 모두 공유됩니다. 따라서, 변수 선언에 다음과 같은 Convention을 권장합니다.
  • {VariableName}_{ScriptId}
  • ex. Investment.1234.lua파일의 n이라는 변수를 사용할 경우, n_1234라는 이름을 권장합니다.

코드 본문 (Investment.0000.lua)

-- Investment condition
function InvestmentData()
    Data = {}
    Data.message = 'Mission require text'
    Data.time_require = 0
    Data.award = 'Reward text'

    return Data
end

-- Call when investment start
-- Used save info when start
function Start()
end

-- Investment appear condition
function Appearance()
    return true
end

-- Investment success condition
function Process()
    return continue
end

-- Investment award
function Award()
end

InvestmentDataStruct = {}
InvestmentDataStruct.InvestmentData = InvestmentData
InvestmentDataStruct.Start = Start
InvestmentDataStruct.Appearance = Appearance
InvestmentDataStruct.Process = Process
InvestmentDataStruct.Award = Award

return InvestmentDataStruct

위 스크립트는 Investment.0000.lua파일의 코드입니다. 이후 참조에 용이하도록, 샘플의 목적으로 배치했습니다. 투자 미션은 위 스크립트를 수정, 추가하는 것으로 구현됩니다. 각 스크립트를 조금 더 작게 나누어 살펴보도록 하겠습니다.

InvestmentData

스크립트 중 InvestmentData 항목입니다.

-- Investment condition
function InvestmentData()
    Data = {}
    Data.message = 'Mission require text'
    Data.time_require = 0
    Data.award = 'Reward text'

    return Data
end

Data의 각 속성은 다음과 같은 역할을 수행합니다.

• Data.message
  • 투자 미션의 내용을 나타냅니다.
• Data.time_require
  • 투자 미션의 수행 기한을 나타냅니다. 단위는 일(Day)입니다.
• Data.award
  • 투자 미션의 보상을 나타냅니다.

위 속성들과 텍스트 중 time_require를 제외하면 UI에 노출되는 설명이며, 실제 기능과는 무관합니다. 위 설명들에 맞춰 아래 함수들을 구현해야 투자 미션의 추가가 완료됩니다.

Start

스크립트 중 Start 항목입니다.

-- Call when investment start
function Start()
end

투자 미션의 시작 시 호출되는 함수입니다. 시작과 함께 실행되어야 하는 함수, 호출되어야 하는 API가 있을 경우 추가할 수 있습니다.

Appearance

스크립트 중 Appearance 항목입니다.

-- Investment appear condition
function Appearance()
    return true
end

투자 미션의 노출 조건을 지정하는 함수입니다. return으로 반환할 수 있는 값은 다음과 같습니다.

• true
  • 투자 미션이 노출됩니다.
• false
  • 투자 미션이 노출되지 않습니다. (나타나지 않습니다)

Process

스크립트 중 Process 항목입니다.

-- Investment success condition
function Process()
    return continue
end

투자 미션의 수행 과정을 검사하는 함수입니다. 투자 미션의 시작 이후 (Start함수 호출 이후) 지속적으로(매 프레임마다) 호출됩니다. return으로 반환할 수 있는 값은 다음과 같습니다.

• continue
  • 투자 미션의 진행에 이상이 없습니다.
• success
  • 투자 미션이 성공합니다. 이후 Award함수가 호출됩니다.
• fail
  • 투자 미션이 실패했습니다. 투자 미션이 종료됩니다.

Award

스크립트 중 Award 항목입니다.

-- Investment award
function Award()
end

투자 미션 성공 시 호출되는 함수입니다. 투자 미션의 보상을 지급하는 기능을 구현할 수 있습니다.

InvestmentDataStruct

InvestmentDataStruct= {}
InvestmentDataStruct.InvestmentData = InvestmentData
InvestmentDataStruct.Start = Start
InvestmentDataStruct.Appearance = Appearance
InvestmentDataStruct.Process = Process
InvestmentDataStruct.Award = Award

return InvestmentDataStruct

코드의 마지막에 있는 InvestmentDataStruct및 return구문입니다. 엔진에서 스크립트를 읽어들이기 위해 반드시 필요한 구문으로, 추가적인 편집은 불필요합니다.

---

샘플 코드

다음 문서는 Lua스크립팅에 관련된 샘플 코드를 첨부하고 있습니다.

Mod scripting guide : Sample code