6-2　モジュールスクリプトを使用した制作

ここでは、プレイヤーがロックピックを拾い、それを使って宝箱を開けることができるというモジュールスクリプトを作成します。

https://prod.docsiteassets.roblox.com/assets/education/coding-6/creating-with-module-scripts/final-example.mp4

プロジェクトのセットアップ

学習用に用意したプロジェクトがファイルがありますので、それをダウンロードして使用します。このファイルには、リーダーボードを表示するプログラムと、ロックピックと宝箱用のモデルと未完成のスクリプトが含まれます。

プロジェクトを読み込む

プロジェクトをダウンロードします。こちらはRoblox Studio でそのまま開けるファイルです。

ダウンロード

ダウンロードしたファイルをRoblox Studioで開きます。

モジュールスクリプトを作成する

プレイヤーがチェストから宝物を取得できるように、TreasureManagerという名前のモジュールスクリプトを作成します。ロックピックを拾った時にこの中のモジュール関数を呼び、リーダーボードの更新ができるようにします。

ServerStorageで、新しい ModuleScript を作成し、名前を TreasureManager に変更します。

TreasureManager で、２か所にある module を TreasureManager に変更します。

local TreasureManager = {}

return TreasureManager

モジュールスクリプトでの関数の使用

getLockpick() という名前の新しいモジュール関数を作成します。この関数は、指定のロックピックを消去し、プレーヤーのインベントリ内にある getkey の数に１を加算するという処理を行います。

keys のモジュール関数を作成する

このモジュールスクリプトは、モジュールとローカル関数の組み合わせを使用します。2 つのコメントを入力して、それらを分けるのに役立てます。

local TreasureManager = {}

------------------ Local Functions

------------------ Module Functions

return TreasureManager

コメント Module Functions の下に getKey() という名前の新しいモジュール関数を追加します。
この関数は次の 2 つのパラメーターを使用します。

keyPart　ー　消去するロックピックパーツ
whichCharacter　ー　ロックピックに触れたプレイヤー

local TreasureManager = {}

------------------ Local Functions

------------------ Module Functions
function TreasureManager.getKey(keyPart, whichCharacter)

end

return TreasureManager

getKey()で、keyPart を消去します。

function TreasureManager.getKey(keyPart, whichCharacter)
    keyPart:Destroy()
end

モジュール機能を使う

これでモジュール関数 getKey() が他のスクリプトから使用できるようになりました。その関数をテストするには、事前に作成されたスクリプトを開いて呼び出します。

Workspace の Keys フォルダに含まれる KeyScript を開きます。
require() を使用し、モジュールスクリプトを tresureManager 変数に入れます。

local ServerStorage = game:GetService("ServerStorage")
-- Require the module script below ⯆
local treasureManager = require(ServerStorage:WaitForChild("TreasureManager"))

local keys = script.Parent
local keysFolder = keys.Parts
local keysArray = keysFolder:GetChildren()

なぜ WaitForChild()?

require(ServerStorage:WaitForChild("TreasureManager")) は、require(ServerStorage.TreasureManager) と記述することもできます。ではなぜ、WaitForChild() 関数を使用するのでしょうか。この関数は、FindFirstChild() と同等の機能があるものですが、名前の通り、指定したオブジェクトが見つかるまで少しの間待機するという機能が備わっているものです。ゲームが起動して、すぐにこの LockpickScript が実行された場合、タイミングによっては、ServerStorage 内に TreasureManager が存在しないことがあります。この関数を使うことで、そのようなエラーを未然に防ぐことができるのです。
なお、ServerScriptService または ServerStorage のスクリプトの場合、ServerStorage.TreasureManagerのように、ドット演算子を使用しても大丈夫です。

プレイヤーがパーツに触れているかどうかをチェックする partTouched() という名前の関数が既にあります。
そこに先ほど作成したモジュール関数を呼ぶコードを追加しましょう。

getKey() モジュール関数を呼び出して、 lockpick を破棄します。
keyPartとwhichCharacter を渡します。

local ServerStorage = game:GetService("ServerStorage")
-- Require the module script below ⯆
local treasureManager = require(ServerStorage:WaitForChild("TreasureManager"))

local keys = script.Parent
local keysFolder = keys.Parts
local keysArray = keysFolder:GetChildren()

local function partTouched(otherPart, keyPart)
    local whichCharacter = otherPart.Parent
    local humanoid = whichCharacter:FindFirstChildWhichIsA("Humanoid")
    if humanoid then
        -- Give the player a key and destroy the key part
        -- =============================================
        treasureManager.getKey(keyPart, whichCharacter)
        -- =============================================
    end
end

プロジェクトを実行し、ロックピックに触れるとそれが消えることを確認します。

https://prod.docsiteassets.roblox.com/assets/education/coding-6/creating-with-module-scripts/get-first-key.mp4

トラブルシューティング

「Infinite yield possible」などのエラーメッセージが表示される

スクリプト内のモジュールスクリプトのスペルを確認します。TreasureManager などのモジュールスクリプトのスペルが異なる場合エラーが発生します。

「attempt to index global」というエラーメッセージが表示される

LockpickScript のモジュールスクリプトの require を含む行を確認します。モジュールに require が含まれていない場合、そのモジュールスクリプトの関数と変数を使用できません。

スクリプトが実行されないか、ロックピックを取得できない

モジュールスクリプトで、すべてのコードが「local TreasureManager = {}」と「return TreasureManager」の間にあることを確認します。return は、モジュールスクリプトの最後の行である必要があります。
「WaitForChild(“TreasureManager”))」のように、require の行の最後に 2 つの括弧があることを確認します。

ローカル関数を作成する

プレーヤーのロックピックとトレジャーリーダーボードの値を変更するには、モジュールスクリプトでローカル関数を使用します。プレーヤーの変数を変更する関数は、このモジュールスクリプト内でのみ使用されるため、ローカル関数です。

ServerStorage の TreasureManager を開きます。
次のことを行うローカル変数を作成します。

Players サービスを取得して、スクリプトがプレーヤーのリーダーボード統計と連携できるようにします。
LockpickPartに触れた後にプレーヤーが受け取るロックピックの数を保存します。

local TreasureManager = {}
local Players = game:GetService("Players")
local keyDrop = 1

------------------ Local Functions

------------------ Module Functions
function TreasureManager.getKey(keyPart, whichCharacter)
    keyPart:Destroy()
end

return TreasureManager

これら 2 つのローカル関数をコピーして、「Local Functions」コメントの下に貼り付けます。

getPlayerKeys() は、プレイヤーの leaderstats 内の Lockpicks を返します。
getPlayerTreasure()は、プレイヤーの leaderstats 内の Treasure を返します。

------------------ Local Functions
local function getPlayerKeys(whichCharacter)
    local player = Players:GetPlayerFromCharacter(whichCharacter)
    local leaderstats = player:FindFirstChild("leaderstats")
    return leaderstats:WaitForChild("Lockpicks")
end
local function getPlayerTreasure(whichCharacter)
    local player = Players:GetPlayerFromCharacter(whichCharacter)
    local leaderstats = player:FindFirstChild("leaderstats")
    return leaderstats:WaitForChild("Treasure")
end
------------------ Module Functions

プレーヤーのロックピックに追加するには、getKey() モジュール関数で次の処理を行います。

getPlayerKeys(whichCharacter) を呼び出し、その戻り値をローカル変数に入れる。
keyDrop の値を playerKeys に追加します。

getPlayerKeys() の戻り値は、IntValue になります。よって、そのプロパティ Value に数値が入ります。

------------------ Module Functions
function TreasureManager.getKey(keyPart, whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    playerKeys.Value = playerKeys.Value + keyDrop
    keyPart:Destroy()
end

プロジェクトを実行します。ロックピックに触れると消去され、リーダーボードのプレイヤーの Lockpicks に 1 が加算されることを確認します。

local TreasureManager = {}
local Players = game:GetService("Players")
local keyDrop = 1

------------------ Local Functions
local function getPlayerKeys(whichCharacter)
    local player = Players:GetPlayerFromCharacter(whichCharacter)
    local leaderstats = player:FindFirstChild("leaderstats")
    return leaderstats:WaitForChild("Lockpicks")
end

local function getPlayerTreasure(whichCharacter)
    local player = Players:GetPlayerFromCharacter(whichCharacter)
    local leaderstats = player:FindFirstChild("leaderstats")
    return leaderstats:WaitForChild("Treasure")
end

------------------ Module Functions
function TreasureManager.getKey(keyPart, whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    playerKeys.Value = playerKeys.Value + keyDrop
    keyPart:Destroy()
end

return TreasureManager

トラブルシューティング

すべてのローカル関数がモジュール関数の上にあることを確認してください。モジュール関数は、その下にあるローカル関数を使用できません。

モジュールスクリプトからの情報の取得

プレイヤーが宝箱を開ける前に、少なくても１つ以上のロックピックを持っているかどうかを確認しなくてはなりません。その際に必要となるモジュール関数を作成します。

チェストが開けられるかどうかを確認する

ServerStorage の TreasureManager で、チェストを開けるのに必要なロックピックの数と、各チェストに入っているゴールドの量の変数を設定します。

local TreasureManager = {}

local Players = game:GetService("Players")
local keyDrop = 1
local chestPickCost = 1
local chestReward = 100

------------------ Local Functions
local function getPlayerKeys(whichCharacter)
    local player = Players:GetPlayerFromCharacter(whichCharacter)
    local leaderstats = player:FindFirstChild("leaderstats")
    return leaderstats:WaitForChild("Lockpicks")
end

プレーヤーがチェストを開けることができるかどうかを確認する関数を作ります。コメント「Module Functions」の下に、canOpenChest() という関数を作成します。パラメーターはプレイヤーになります。

------------------ Module Functions
function TreasureManager.canOpenChest(whichCharacter)

end

function TreasureManager.getKey(keyPart, whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    playerKeys.Value = playerKeys.Value + keyDrop
    keyPart:Destroy()
end

以下のコードをコピーして canOpenChest() に貼り付け、プレーヤーがロックピックを持っている場合は true を返し、まだ持っていない場合は false を返します。

function TreasureManager.canOpenChest(whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    if playerKeys.Value >= chestPickCost then
        return true
    else
        return false
    end
end

プレイヤーに宝物を与える

プレイヤーが宝箱を開けたときに実行される関数を作成します。プレイヤーに宝物を与えます。

openChest() という名前の新しいモジュール関数を TreasureManager に追加します。
この関数には２つのパラメーターがあります。

chestPart　ー　宝箱チェスト
whichCharacter　ー　宝物を与えるプレイヤー

function TreasureManager.openChest(chestPart, whichCharacter)

end

以下のコードをコピーして openChest() に貼り付けてください。
プレイヤーのロックピック数を減らし、ゴールドを与えます。最後にチェストを消します。

function TreasureManager.openChest(chestPart, whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    local playerTreasure = getPlayerTreasure(whichCharacter)
    playerKeys.Value = playerKeys.Value - chestPickCost
    playerTreasure.Value = playerTreasure.Value + chestReward
    chestPart:Destroy()
end

チェスト関係のモジュール関数を呼び出す

２つのモジュール関数 canOpenChest() と openChest() が完成したところで、プレイヤーがチェストに触れたときに、この関数を呼び出すようにします。

Workspace の中の Chests フォルダにある ChestScript を開きます。
KeyScript で行ったように、require() を使ってモジュールスクリプトをロードし、treasureManager 変数に代入しておきます。

local ServerStorage = game:GetService("ServerStorage")
-- Require the module script below
local treasureManager = require(ServerStorage:WaitForChild("TreasureManager"))

local chests = script.Parent
local chestsFolder = chests.Parts
local chestsArray = chestsFolder:GetChildren()

partTouched() の「 if humanoid」ステートメントの下に、先ほど作成したモジュール関数 canOpenChest() を呼び出し、その値を canOpen 変数に代入するようにします。この変数には true か false が入ります。

TreasureManager.canOpenChest(どのキャラクター)

local function partTouched(otherPart, chestPart)
    local whichCharacter = otherPart.Parent
    local humanoid = whichCharacter:FindFirstChildWhichIsA("Humanoid")
    if humanoid then
        -- Check if the player can open a chest, then let them get treasure
        -- =============================================
        local canOpen = treasureManager.canOpenChest(whichCharacter)
        -- =============================================
    end
end

次に canOpen が true かどうかを確認する if ステートメントを追加します。true だった場合は、ピックロックを持っていますので宝箱を開るために、openChest() を呼びます。

local function partTouched(otherPart, chestPart)
    local whichCharacter = otherPart.Parent
    local humanoid = whichCharacter:FindFirstChildWhichIsA("Humanoid")
    if humanoid then
        -- Check if the player can open a chest, then let them get treasure
        -- =============================================
        local canOpen = treasureManager.canOpenChest(whichCharacter)
        if canOpen == true then
            treasureManager.openChest(chestPart, whichCharacter)
        end
        -- =============================================
    end
end

プロジェクトを実行し、以下の動作を確認します。

ロックピックが１つ以上ある場合、チェストに触れるとチェストが消え、宝物が手に入ります。
ロックピックが０の場合、宝箱を開けられません。

トラブルシューティング

モジュール関数を呼ぶ側と、呼ばれる側の関数のスペルは完全に一致していないとエラーになります。
すでに入っているプログラムが常に正しいとも限りません。単語の下に赤いアンダーバーがある部分は修正が必要なところです。エラーになっている箇所は修正してください。

完成したスクリプト

完成した TreasureManager

local TreasureManager = {}
local Players = game:GetService("Players")
local keyDrop = 1
local chestPickCost = 1
local chestReward = 100

------------------ Local Functions
local function getPlayerKeys(whichCharacter)
    local player = Players:GetPlayerFromCharacter(whichCharacter)
    local leaderstats = player:FindFirstChild("leaderstats")
    return leaderstats:WaitForChild("Lockpicks")
end

local function getPlayerTreasure(whichCharacter)
    local player = Players:GetPlayerFromCharacter(whichCharacter)
    local leaderstats = player:FindFirstChild("leaderstats")
    return leaderstats:WaitForChild("Treasure")
end

------------------ Module Functions
function TreasureManager.openChest(chestPart, whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    local playerTreasure = getPlayerTreasure(whichCharacter)
    playerKeys.Value = playerKeys.Value - chestPickCost
    playerTreasure.Value = playerTreasure.Value + chestReward
    chestPart:Destroy()
end

function TreasureManager.canOpenChest(whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    if playerKeys.Value >= chestPickCost then
        return true
    else
        return false
    end
end

function TreasureManager.getKey(keyPart, whichCharacter)
    local playerKeys = getPlayerKeys(whichCharacter)
    playerKeys.Value = playerKeys.Value + keyDrop
    keyPart:Destroy()
end

return TreasureManager

完成した ChestScript

local ServerStorage = game:GetService("ServerStorage")
-- Require the module script below ⯆
local treasureManager = require(ServerStorage:WaitForChild("TreasureManager"))

local chests = script.Parent
local chestsFolder = chests.Parts
local chestsArray = chestsFolder:GetChildren()

local function partTouched(otherPart, chestPart)
    local whichCharacter = otherPart.Parent
    local humanoid = whichCharacter:FindFirstChildWhichIsA("Humanoid")
    if humanoid then
        -- Check if the player can open a chest, then let them get treasure
        -- =============================================
        local canOpen = treasureManager.canOpenChest(whichCharacter)
        if canOpen == true then
            treasureManager.openChest(chestPart, whichCharacter)
        end
        -- =============================================
    end
end

-- Binds every chest part to the touch function so it works on all parts
for chestIndex = 1, #chestsArray do
    local chestPart = chestsArray[chestIndex]:WaitForChild("Collider")
    chestPart.Touched:Connect(function(otherPart)
        partTouched(otherPart, chestPart)
    end)
end

完成した keyScript

local ServerStorage = game:GetService("ServerStorage")
-- Require the module script below ⯆
local treasureManager = require(ServerStorage:WaitForChild("TreasureManager"))

local keys = script.Parent
local keysFolder = keys.Parts
local keysArray = keysFolder:GetChildren()

local function partTouched(otherPart, keyPart)
    local whichCharacter = otherPart.Parent
    local humanoid = whichCharacter:FindFirstChildWhichIsA("Humanoid")
    if humanoid then
        -- Give the player a key and destroy the key part
        -- =============================================
        treasureManager.getKey(keyPart, whichCharacter)
        -- =============================================
    end
end

-- Binds every key part to the touch function so it works on all parts
for keyIndex = 1, #keysArray do
    local keyPart = keysArray[keyIndex]
    keyPart.Touched:Connect(function(otherPart)
        partTouched(otherPart, keyPart)
    end)
end

[ 6-1 モジュールスクリプトの概要 ]

[ 6-3 コーディングの抽象化 ]

2 thoughts on “6-2　モジュールスクリプトを使用した制作”

blacksmithMT より:

2024年9月1日 13:33

こんにちは。いつも、ありがとうございます。
最後にある完成スクリプトがダウンロードできませんでした。
また、本文中のlockpicksがkeysになっているようですね。その点は、逐次、自己解決しました。
ただ、鍵をもって宝箱に触れるとリーダーボードの値は正しく変化しますが、最後に宝箱がDestroyされずに残ってしまいます。
なぜでしょうか？
＞モジュールソースの該当部分（数値は正しく変化しているので、Destroyだけがおかしいのだろうと思っています）
function TreasureManager.openChest(chestPart, whichCharacter)
–print(“Called openChest.”)
local playerLockpicks = getPlayerLockpicks(whichCharacter)
local playerTreasure = getPlayerTreasure(whichCharacter)
playerLockpicks.Value = playerLockpicks.Value – chestPickCost
playerTreasure.Value = playerTreasure.Value + chestReward
chestPart:Destroy()
end

ログインして返信する
1. schilverberch より:
  
  2024年9月1日 14:45
  
  ご指摘ありがとうございます。ソースがかなり変更されたようです。
  すべて見直して修正させていただきました。
  完成したスクリプトをコピペして動作確認させていただきましたので、こちらで問題ないかと思います。
  宝箱も消えました！
  
  ログインして返信する

コメントを残すコメントをキャンセル

コメントを投稿するにはログインしてください。

プロジェクトのセットアップ

プロジェクトを読み込む

モジュールスクリプトを作成する

モジュールスクリプトでの関数の使用

keys のモジュール関数を作成する

モジュール機能を使う

トラブルシューティング

「Infinite yield possible」などのエラーメッセージが表示される

「attempt to index global」というエラーメッセージが表示される

スクリプトが実行されないか、ロックピックを取得できない

ローカル関数を作成する

トラブルシューティング

モジュールスクリプトからの情報の取得

チェストが開けられるかどうかを確認する

プレイヤーに宝物を与える

チェスト関係のモジュール関数を呼び出す

トラブルシューティング

完成したスクリプト

完成した TreasureManager

完成した ChestScript

完成した keyScript

2 thoughts on “6-2　モジュールスクリプトを使用した制作”

コメントを残すコメントをキャンセル

You missed

サウンドのエラー

プレイヤーの上に文字を表示

Frameを中央に表示

プロパティ変化のイベント

6-2 モジュールスクリプトを使用した制作

プロジェクトのセットアップ

プロジェクトを読み込む

モジュールスクリプトを作成する

モジュールスクリプトでの関数の使用

keys のモジュール関数を作成する

モジュール機能を使う

トラブルシューティング

「Infinite yield possible」などのエラー メッセージが表示される

「attempt to index global」というエラー メッセージが表示される

スクリプトが実行されないか、ロックピックを取得できない

ローカル関数を作成する

トラブルシューティング

モジュールスクリプトからの情報の取得

チェストが開けられるかどうかを確認する

プレイヤーに宝物を与える

チェスト関係のモジュール関数を呼び出す

トラブルシューティング

完成したスクリプト

完成した TreasureManager

完成した ChestScript

完成した keyScript

2 thoughts on “6-2 モジュールスクリプトを使用した制作”

コメントを残す コメントをキャンセル

You missed

サウンドのエラー

プレイヤーの上に文字を表示

Frameを中央に表示

プロパティ変化のイベント

6-2　モジュールスクリプトを使用した制作

「Infinite yield possible」などのエラーメッセージが表示される

「attempt to index global」というエラーメッセージが表示される

2 thoughts on “6-2　モジュールスクリプトを使用した制作”

コメントを残すコメントをキャンセル