Lead in(はじめに) このチュートリアルでは 基 本 の[Entity]の 追 加 方 法 を 述 べます もっと 詳 しく 知 りたい 場 合 Crysis のスクリプトを 調 べてみてください 作 成 した[Entity]がモデルとして In-game にも 使 用 できます 作 成 した

Transcription

1 ( 文 字 のフォント:Comic Sans MS) S&C002_[Doc] Creating a new Entity( 新 規 の[Entity]を 作 成 します ) Description( 解 説 ): フローグラフのサポートを 得 ながら Lua スクリプトの 作 成 により 新 たな[Entity]を 追 加 します Reference( 参 考 資 料 参 考 サイト) タイトル:Creating a new entity 作 成 者 :Ins Skill Level: 中 級 チュートリアルタイプ: 資 料 [Doc] キーワード:Scripting 解 説 者 の 情 報 解 説 者 :Crysis Sandbox2 In-Deep 管 理 者 ホームページ URL: E メール:alexwchvui@hotmail.com このチュートリアルに 対 するコメント: - [* 正 ][Inputs][Outputs]コードを[FlowEvents]コードの 上 に 記 入 します ページ 数 :17 ページ S&C002_Page1

2 Lead in(はじめに) このチュートリアルでは 基 本 の[Entity]の 追 加 方 法 を 述 べます もっと 詳 しく 知 りたい 場 合 Crysis のスクリプトを 調 べてみてください 作 成 した[Entity]がモデルとして In-game にも 使 用 できます 作 成 した[Entity] を 使 用 すると [Entity]が 複 製 され オリジナル[Entity]の 隣 に 配 置 されます このチュートリアルは Crysis の SDK ではありません [luacompiler.zip]をダウンロードして 解 凍 します [LuaCompiler.exe]を[..\Crysis\ bin32]フォルダにコピーします S&C002_Page2

3 Step 001 : Setting up an entity ([Entity]を 設 定 します ) [..\Crysis\Mods\]フォルダに 空 フォルダ[MyMod]を 作 成 します [Editor.exe] ショートカットのプロパティ [ショートカット] タブ [リンカ 先 ]に [ -DEVMODE -MOD MyMod ]を 追 加 します [MyMod]フォルダに[Game] 新 規 フォルダを 作 成 します [Game]フォルダに [entities] 新 規 フォルダを 作 成 します [entities]フォルダにテキストエディタで [MyEntity.ent] 新 規 ファイルを 作 成 します - [.ent] 形 式 ファイルはゲームエンジンに[entity]をロードさせるためです S&C002_Page3

4 テキストエディタで[MyEntity.ent]を 開 き 以 下 のように 追 加 します <Entity Name = MyEntity Script = Scripts/Entities/MyMod/MyEntity.lua /> [Note]: [MyMod][MyEntity] 以 外 の 名 前 は 自 由 に 設 定 できます STEP002 : The entity script(basics) [Entity] スクリプトの 基 本 [entity](myenity.ent)を 設 定 したら Lua ファイルを 作 成 します Lua ファイルに [Entity]のプロパティとコードを 書 きます [MyEnity.ent]で 書 かれたパス[..\Scripts\Entities\MyMod\MyEntity.lua]の 同 じ ように[MyEntity.lua] 新 規 ファイルを 作 成 します [..\Crysis\Game\scripts\entities\MyMod\] 空 フォルダを 作 成 し その 中 にテキ ストエディタで[MyEntity.lua] 新 規 ファイルを 作 成 します [Note]:Sandbox2 エディタは Mod フォルダの[Entities]ファイルの 編 集 更 新 し ないため デフォルトのフォルダ[..\Crysis\Game\]フォルダに[Entities]ファイル を 作 成 します テキストエディタで[MyEntity.lua]ファイルを 開 き 以 下 のように 記 入 します MyEntity = { Properties = { fmessageduration = 10.0, smessage = Use me, bdoesnothing = 0, object_mymodel = Editor/Objects/objective.cgf, Colors = { clrcolor = {x=1,y=0,z=0}, }, }, S&C002_Page4

5 }; Editor = { Icon = Target.bmp, }, Lua コードの 解 説 : - MyEntity = {... } : Entity を 宣 言 します - 次 に プロパティを 設 定 します それらのプロパティは Sandbox2 エディタの [Entity Properties]で 変 更 できます -- fmessageduration : [Entity]を 使 用 する 際 メッセージの 表 示 時 間 -- smessage : 表 示 されるメッセージ -- bdoesnothing : 何 もしない -- object_mymodel : [Entity]にモデルの 指 定 -- clrcolor : メッセージの 色 各 パラメータ 名 の 前 に [ f ][ s ][ b ][ clr ]の 接 頭 文 字 が 付 けます その 理 由 は Sandbox2 に 変 数 の 型 を 指 定 するためです - b : boolean true または false - s : string 文 字 列 - f : float 4 バイト 単 精 度 浮 動 小 数 点 数 - object_ : モデル(ファイル 開 くダイアログ 付 き) - clr : 色 ( 色 選 択 ダイアログ 付 き) -- clrcolor に 更 のプロパティテーブル[x][y][z]があります Sandbox のサブカテ ゴリです S&C002_Page5

6 [Properties]の 次 に [Editor]のプロパティです Sandbox で 使 用 するアイコンを 設 定 します - Editor = { Icon= Target.bmp, }; Lua ファイルに 他 の 変 数 の 指 定 もできます ここでは 以 上 の 設 定 で 終 わります STEP 003: Sandbox2 エディタを 起 動 します 作 成 した Mod 用 の[Editor.exe]ショートカットをダブルクリックして Sandbox2 エディタを 起 動 します マップを 開 かないまま [RollupBar] [Objects] [Entity] を 選 択 して [MyMod] [MyEntity] がロードされたことを 確 認 します [MyEntity]をダブルクリックして [Entity Properties]の 表 示 が 正 しいことを 確 認 します 文 字 の 前 に[?][ab][n][ ] などの 記 号 が 現 れます S&C002_Page6

7 [Note]:[Entity Properties]が 表 示 されなかった 場 合 [Tools]メインメニュー [Reload Scripts]を 選 択 して [Errors Report]を 確 認 します - エラーの 所 を 確 認 して Lua の 内 容 を 修 正 して 上 書 き 保 存 してください Sanbox2 エディタをもう 一 度 再 起 動 してください STEP 004 : Lua スクリプトに 更 のコードを 追 加 します Sandbox2 エディタを 起 動 したまま [MyEntity.lua]にコードを 追 加 します STEP003 の 設 定 では [MyEntity]が 何 も 機 能 しないので 更 のコードを 以 下 のよ うに 追 加 します Function MyEntity:OnInit() self:onreset(); [ 解 説 :] - OnInit() : マップを 開 く 時 に [Entity]の 初 期 設 定 をゲットします - 次 に OnReset()の 機 能 を 呼 び 出 します (*OnReset()の 機 能 を 次 から 作 成 しま す ) S&C002_Page7

8 [OnReset()] 機 能 を 追 加 します function MyEntity:OnReset() if(self.properties.object_mymodel ~="") then self:loadobject(0,self.properties.object_mymodel); [ 解 説 ]:エディタが 起 動 する 時 また [OnInit()]から[OnReset()]の 機 能 が 呼 び 出 され 自 分 をロードします [if]もしモデルが[~= ] 空 string でなかったら [then] モデルをロード[LoadObject]します [MyEntity.lua]を 上 書 き 保 存 します Sandbox2 エディタで 適 当 なマップを 開 きます [MyEntity]をマップ 上 に 配 置 して [Reload Script]ボタンをクリックすると Lua コードが 再 ロードされます [*Note]:[Edit Script]ボタンはデフォルト[..\Crysis\Game\Scripts\Entities\]フォ ルダ 内 のファイルのみを 開 きます [Reload Script]ボタンは[..\Crysis\Bin32\]フォ ルダ 内 に[LuaCompiler.exe]があったら 実 行 されます S&C002_Page8

9 [Entity Properties] [MyModel] の[ 開 く]アイコンをクリックして 適 当 なモデル を 選 択 して [Reload Script]ボタンをクリックして モデルが 変 わったことを 確 認 します もし モデルが 更 新 しなかったら 以 下 の[OnPropertyChange()] 機 能 を 追 加 して ください Function MyEntity:OnPropertyChange() self:onreset(); -[ 解 説 ]:[OnPropertyChange()]の 機 能 はエディタでの[Entity Properties]が 変 更 された 場 合 [Reload Script]ボタンをクリックしなくでも 自 動 更 新 されます (*[Reload Script]ボタンをクリックせずに モデルを 変 更 してみてください ) 現 時 点 の 設 定 では [MyEntity]にモデルをロード 変 更 できます 次 に [MyEntity]を 使 えるように[IsUsable][GetUsableMessage] 機 能 を 追 加 しま す function MyEntity:IsUsable(user) return 2; funtion MyEntity:GetUsableMessage(idx) return self.properties.smessage; S&C002_Page9

10 [ゲームモード]に 切 り 替 え [MyEntity]に 近 づくと [Use Me]の 表 示 が 現 れること を 確 認 します [ 解 説 ]: - [IsUsable() return 2]は[MyEntity]を 使 えるように 設 定 します - [GetUsableMessage]は[MyEntity]が 使 用 される 際 にメッセージを 表 示 される 機 能 です プロパティの[sMessage: Use me] を 表 示 メッセージとして 使 用 します 現 時 点 では [MyEntity] 使 用 できるようにしたが 更 の 使 用 目 的 の 機 能 を 追 加 しま す Function MyEntity:OnUsed(user,idx) CryAction.Persistant2DText(string.format( Used>%s, self.properties.smessage),2,self.properties.colors.clrcolor, OnUsed,self.Prope rties.fmessageduration); [Reload Script]を 実 行 してから [ゲームモード]に 切 り 替 え [F]キーを 数 回 押 す と [Used>Use me]の 文 字 がプレイヤーの HUD に 現 れます また 時 間 が 経 つと [Used>Use me]の 文 字 をだんだん 薄 くなります S&C002_Page10

11 [ 解 説 ]: - プレイヤーのスクリーン 上 にメッセージを 表 示 される 機 能 の 設 定 です メッセー ジは[User>self.Properties.sMessage] プロパティの[sMessage: Used me]です - 第 2 項 目 :メッセージのサイズです 通 常 [2]に 設 定 します - 第 3 項 目 :[ 色 ] 指 定 です プロパティの[Color]です - 第 4 項 目 :メッセージの 名 前 です - 第 5 項 目 :メッセージの 表 示 時 間 [ 秒 単 位 ]です (*プロパティをいじって その 結 果 を 確 認 してみてください ) 以 下 [MyEntity.Lua] 全 体 のコードです S&C002_Page11

12 Step005 : Exting our entity ([Entity]を 拡 張 します ) Step004 で 基 本 の[MyEntity]を 設 定 した ここから 更 のコードを 追 加 します まず [MyEntity]に 物 理 的 なモデルに 設 定 します [OnReset()] 機 能 に[PhysicalizeThis]を 以 下 のように 追 加 します Function MyEntity:OnReset() if(self.properties.object_mymodel~= )then self:loadobject(0,self.properties.object_mymodel); self:physicalizethis(); function MyEntity:PhysicalizeThis() local Physics={ brigidbody=1, brigidbodyactive=0, brigidbodyafterdeath=1, bresting=1, Density=-1, Mass=5, }; EntityCommon.PhysicalizeRigid(self,0,Physics,1); [ 解 説 ]:エディタで 使 用 されるパラメータを 確 認 しながら [PhysicalizeThis] 機 能 に 物 理 を 設 定 します それらの 設 定 を[EntityCommon.PhysicalizeRigid()]に 渡 しま す これで [MyEntity]が 物 理 的 に 機 能 されます [ゲームモーで]に 切 り 替 えて 確 認 します (* 物 理 的 な 設 定 をできないモデルがあるため 確 認 してみてください ) S&C002_Page12

13 次 に [MyEntity]を 使 う 時 に [MyEntity]を 複 製 する 機 能 のコードを 追 加 します function MyEntity:OnUsed(user, idx) CryAction.Persistant2DText(string.format("Used> %s", self.properties.smessage),2, self.properties.colors.clrcolor, "OnUsed", self.properties.fmessageduration); self:clone(); function MyEntity:Clone() local clone = { class = "MyEntity", }; clone.properties = self.properties; local ent = System.SpawnEntity(clone); local pos = self:getpos(); pos.x = pos.x + 1; ent:setpos(pos); S&C002_Page13

14 [ 解 説 ]:これで[MyEntity]を 複 製 できます - まず クラスを[MyEntity]に 設 定 して デフォルトの 値 で[MyEntity]を 生 成 しま す - [clone.properties=self.properties;] : [MyEntity]のプロパティを[Clone]プロパティに 渡 します - [local pos=self:getpos();] : [MyEntity]の 位 置 をゲートします - pos.x=pos.x+1; : [MyEntity]の 位 置 に[1]の 値 を 足 します (そうすると 複 製 した[Entity]をはっ きり 分 かります ) - [ent:setpos(pos)] : [1]を 足 した 位 置 を 複 製 した[Clone]に 設 定 します Step 006 : Adding Flowgraph support(フローグラフのサポートを 追 加 ) すべてのフローグラフ 情 報 は[FlowEvents]にあります それを 定 義 しなければなり ません 以 下 のようなコードを 追 加 します MyEntity.FlowEvents={ Inputs= { Clone={MyEntity.Event_Clone, bool }, Message={MyEntity.Event_Message, string }, }, Outputs= { Used= bool, }, } [ 解 説 ]:フローグラフの 設 定 はそれほど 難 しくない フローグラフのノードに [Inputs]と[Outputs] 部 分 があります [Inputs] 側 に[Clone]と[Message]をゲート します [MyEntity]が 使 用 された 際 に [Outputs] 側 に[Used] 機 能 が 呼 び 出 されま す [ 疑 問 ]:[Clone=?]と[Message=?] それから [MyEntity.Event_Clone]と [MyEntity.Event_Message]はどこから 定 義 される?? S&C002_Page14

15 [ 答 え]:それらも 定 義 しなけらばなりません 以 下 のように 定 義 します function MyEntity:Event_Clone(ser) self:clone(); function MyEntity:Event_Message(ser,msg) self.properties.smessage=msg; [ 解 説 ]:[Event_Clone]は[Clone()] 機 能 を 呼 び 出 すだけです [Event_Message]で はフローグラフでのプロパティを 変 更 できます これで [Inputs] 側 の 設 定 を 終 わ りました [Outputs] 側 は[Outputs]の[Event]を 始 動 させる 所 にコードを 追 加 します function MyEntity:OnUsed(user, idx) CryAction.Persistant2DText(string.format("Used> %s", self.properties.smessage),2, self.properties.colors.clrcolor, "OnUsed", self.properties.fmessageduration); self:clone(); self:activateoutput( Used,true); [OnUsed()] 機 能 に[Used]を[true]に 設 定 するだけです これで フローグラフの 設 定 を 終 わりました [MyEntity.lua]を 上 書 き 保 存 します Sandbox2 エディタをもう 一 度 再 起 動 します 適 当 なマップを 開 きます Sandbox2 エディタで[MyEntity]をマップに 配 置 します [Flow Graph] [Create] ボタンをクリックします S&C002_Page15

16 適 当 なグループ 名 を 記 入 して [OK]ボタンをクリックします [MyEntity]を 選 択 したまま [Flow Graph]ウィンドウのグレー 所 にマウス 右 クリッ クして [Add Graph Default Entity][Fit Graph to View]を 選 択 すると 作 成 した [entity:myentity]ノードが 現 れます グレー 所 にマウス 右 クリックして [Add Node] [HUD] [DisplayInstructionmMessage]ノードを 追 加 して 以 下 のように 設 定 します [ゲームモード]に 切 り 替 えして [MyEntity]の 前 に[F]キーをクリックして [Flowgraph is here]のメッセージ [Used>Use me]のテキスト [Clone]が 生 成 され たことを 確 認 します S&C002_Page16

17 [* 注 ]:[Event_Clone][Event_Message]の[Inputs]と[FlowEvents]コードの 順 が 間 違 った 場 合 [Inputs] 側 が 表 示 できなくなります [* 正 ][Inputs][Outputs]コードを[FlowEvents]コードの 上 に 記 入 します S&C002_Page17