RaycastParamsデータ型

データ型日本語解説あり

ひとことで言うと

レイキャスト(見えない光線)で、何を調べて何を無視するかを決めるデータ型です。

公式の説明(英語):A container for parameters used in raycasting operations.

使用例

光線(レイキャスト)で地面を調べる
Script置く場所:ServerScriptService
local origin = Vector3.new(0, 50, 0)
local direction = Vector3.new(0, -100, 0)

local params = RaycastParams.new()
params.FilterType = Enum.RaycastFilterType.Exclude

local result = workspace:Raycast(origin, direction, params)
if result then
	print("当たったもの:" .. result.Instance.Name, result.Position)
end

スクリプトは、Luauの型チェック(luau-lsp)で確認しています。

コンストラクター(作り方)(1)

名前と書き方説明
new
RaycastParams.new()
Returns a blank RaycastParams.

プロパティ(10)

名前と書き方説明
ExcludeInstances
RaycastParams.ExcludeInstances: {Instance}?
An optional array of instances whose descendants will be excluded from the query.
IncludeInstances
RaycastParams.IncludeInstances: {Instance}?
An optional array of instances whose descendants will be included in the query.
IgnoreWater
RaycastParams.IgnoreWater: bool
Determines whether the water material is considered when raycasting against Terrain.
CollisionGroup
RaycastParams.CollisionGroup: string
The collision group used for the operation.
RespectCanCollide
RaycastParams.RespectCanCollide: bool
Determines whether the raycast operation considers a part's Class.BasePart.CanCollide|CanCollide property value over its Class.BasePart.CanQuery|CanQuery value.
BruteForceAllSlow
RaycastParams.BruteForceAllSlow: bool
When enabled, the query will ignore all part collision properties and perform a brute-force check on every part.
Margin
RaycastParams.Margin: number
Expands the cast shape uniformly in every direction.
SizeGradient
RaycastParams.SizeGradient: number
Scales the cast shape over the length of the cast, tapering the swept volume.
FilterDescendantsInstances
RaycastParams.FilterDescendantsInstances: Array
An array of objects whose descendants are used to filter raycasting candidates.
FilterType
RaycastParams.FilterType: RaycastFilterType
Determines whether the Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances array is used as an exclude or include list.

メソッド(1)

名前と書き方説明
AddToFilter
RaycastParams:AddToFilter(instances: Instance | Array): ()
Adds the instances provided to Datatype.RaycastParams.FilterDescendantsInstances|FilterDescendantsInstances.

英語の説明とメンバーの一覧は、Roblox Creator Documentation(RaycastParams)をもとにしています(CC BY 4.0)。日本語の解説は、このサイトで独自に書いたものです。

執筆:鈴木孝昌官公庁のWeb・システム開発を担当する現役プロジェクトマネージャー。沖縄マイクラ部 クロスウェーブで、ロブロックス(Roblox)・マインクラフト(マイクラ)・Scratchなどのプログラミングを指導。マイクラカップ沖縄代表チームを指導(第6回・第7回、第7回TBS賞)。
沖縄マイクラ部で、子どもたちにロブロックス(Roblox)やマインクラフト(マイクラ)のプログラミングを教えています。プロフィールと編集方針
Instagramで教室の様子を見る
noteで記事を読む