Skip to content

Japanese (日本語)

Jump to bottom
ilyshk4 edited this page May 8, 2022 · 35 revisions

Mod Version: 1.2.0

Lua Scripting Mod ユーザーマニュアル (JP)

Table Of Contents

導入

この mod は、コンパイルの手順を踏まずにゲーム内で Lua スクリプトを作成して実行する機能を提供し、マルチプレイにも対応することで、より複雑なマシンを作成することを補助します。スクリプトはローカルプレイヤーのマシンのみ制御でき、レベルオブジェクトやほかのプレイヤーのマシンには一切影響を与えません。

UniLuaの著者さんありがとう！

便利なリンク

この Mod でできること

  • マシンをロードしたり、新規作成したりすると、MOD はそのマシンの LuaRoot ファイルを探し、あれば自動的にロードします。無い場合は、現在のマシンに新しい LuaRoot を作成します。
  • LuaRoot は全ての Lua ファイルやフォルダが格納されているディレクトリです。Ctrl+L を押すと表示される Mod メニューのOpen LuaRootボタンでこのフォルダを開けます。
  • マシンを再生すると、Mod はmain.luaというスクリプトを実行し、致命的なエラーが無ければ、Mod は LuaRoot をマシンに保存します。
  • マシンを保存すると、Lua のセーブも行われます。Save LuaRoot manualyボタンでも保存されます。
  • Machine のスクリプトには全ての unity のコールバックが含まれます。デフォルトの Lua スクリプトファイルには全てのコールバックについて簡単な説明書きが書いてあります。

この Mod の概要

  • 主な機能として、play、update、late_update、fixed_update、on_gui があります。これらに関してはUnity Scripting API を参照してください。
    • play はシミュレーション開始時に読み込まれます。ほとんど役に立ちません。
    • update はフレーム更新のたびに読み込まれます。 プレイヤーの入力の検出に用います。
    • late_update はフレーム更新後に呼び出されます。
    • fixed_update は 1 秒ごとに一定回数（100Hz）呼び出されます。物理演算などに用います。
    • on_gui は、画面上に GUI を描画するためだけに呼び出されます。
  • キーのエミュレートは key emulatorによって行います。起動、停止、クリックを行うことができます。
local some_key_emulator = machine.new_key_emulator('c')
some_key_emulator.start()
some_key_emulator.stop()
some_key_emulator.click()
  • パーツ設定のそれぞれのスライダーの値は、新しい reference controllerを作成することで変更できます。reference controller は、同じreference keyが与えられたパーツには同じ制御を行います。
  1. ブロックにreference keyを割り当てます。ここでは車輪を用います。車輪を強制的に回転させるのではなく、速度を変えているので、自動をオンにするのを忘れないようにしましょう。この画像の場合、reference keyは rotorと名付けました。

Assign reference key to the block.

  1. 変更したいスライダーの mapper type を調べます。ctrl+Lを押した状態でパーツ設定を開くと確認できます。 ここでは speedのスライダーの値を変更することにします。

Find out mapper type key name of the slider you are changing.

  1. 新しい reference controller を作り、速度を設定します。
local rotor = machine.get_refs_control('rotor')
rotor.set_slider('speed', 0.5)
  • ステアリングヒンジ等の操舵角の調整は、reference controllerを作成し、set_steeringを用い、以下のように行えます。
local hinge = machine.get_refs_control('hinge')
hinge.set_steering(45)
  • ブロックの位置や回転、速度などの情報は、新たにblock infoを作成することで取得できます。
local machine_info = machine.get_machine_info()
local starting_block = machine_info.get_block_info(0)
local position = starting_block.position()
  • また、他のプレイヤーのブロックやマシンの情報を得ることも可能です。
for i = 0, players.count() - 1 do
	local player = players.get(i)
	if not player.is_local_player() and player.is_simulating() then
		local enemy_position = players.get(i).get_machine_info().get_block_info(0).position()
		print('enemy at height ' .. enemy_position.y)
	end
end
  • レイキャスト（センサーみたいなこと）はphysicsを用いて行えます。
local raycast_start = vector.add(starting_block.position(), vector.multiply(starting_block.up(), -0.5))
local raycast_direction = vector.multiply(starting_block.up(), -1)
local raycast_hit = physics.raycast(raycast_start, raycast_direction)
  • 指定された半径内のコライダー情報の取得なんかもphysicsでできます。
local colliders = physics.overlap_sphere(starting_block.position(), 5)
for i in pairs(colliders) do
	print(colliders[i].is_block)
end
  • 線の描画はlinesを使って行います。
local line = lines.new_line_renderer()
line.set_points(vector.new(0, 0, 0), vector.new(10, 10, 10))
  • チャットメッセージは、新しいchat listenerを作成することで処理できます。 コールバック関数を宣言した後にリスナーを追加しなければならないことを忘れずに。
local function on_chat(sender, text)
	print(sender .. ' just said ' .. text)
end

chat.add_listener(on_chat)

頭にニックネームをつけずにリッチテキストでチャットメッセージを書く事ができます。

chat.set_visible(true)

chat.write_local('<color=\"red\">Only you can see this!</color>')
chat.write_team('<color=\"red\">Only your team can see this!</color>')
chat.write_global('<color=\"green\">Hello, everyone!</color>')
  • 新しい機能もドシドシ募集中！

モジュールシステム

通常のモジュールシステムでは、同じスクリプトを使い、マシンの異なるパーツを別々に制御することができる。

例

あるロケットにスクリプトを書き、これを何度もコピーし、他の多数のロケットにrocket.luaスクリプトをアタッチした新しいモジュールを作ることができる。 サンプルマシン

Usage

  1. アドバンスビルドをONにする。
  2. Ctrl+LでLuaScriptingウィンドウを開く。
  3. Open LuaRoot folderボタンでLuaRootフォルダを開く。
  4. main.luaスクリプトのコピーを作成し、必要に応じて名前を変更する。
  5. Modulesボタンを押し、Modulesウィンドウを開く。
  6. Newを押して新しいモジュールを作成する。
  7. 任意の名前を設定し、先に作成したスクリプトのファイル名を入力する。
  8. 移動ツールを選択する。
  9. ModulesウィンドウのSet blocksを押す。
  10. 選択ツールを使い、モジュールのスクリプトでアクセスしたいブロックをすべて選ぶ。 他のスクリプトは同じ参照キーを持っていてもブロックにはアクセスできない。どのブロックがモジュールの制御化にあるのかは、移動ツールをONにした状態でSelectを押すと確認できる。※注:スターティングブロックはビルトインデックスのみによって参照できるため、Modulesシステムで選択することはできない。

Lua のテーブル

この Mod で使われている Lua インタプリンタにはオブジェクト指向プログラミングのようなものはありませんが、テーブル型はあります！テーブル型は値を格納したり、関数を格納したりできます。但し参照は無く、毎回新しいテーブルが生成されるだけなので注意してください（参照はいずれ導入するかも）。

Rectangle

矩形

Created by rectangle library using rect.new(...)

field type
x int
y int
width int
height int

Vector

ベクトル

Created by vector library using vector.new(...)

field type
x number
y number
z number
w number

Quaternion

Created by quaternion library using quaternion.euler(...)

field type
x number
y number
z number
w number

Key Emulator

キーのエミュレーター

Created by machine library using machine.new_key_emulator(...).

field type
start function (no args; void)
stop function (no args; void)
click function (no args; void)
active function (no args; returns boolean)

Refs Controller

リファレンスコントローラー

Created by machine library using machine.get_refs_control(...).

field type
set_slider function (args: string mapper_key, number value; void)
set_steering function (args: number angle; void)

Block Info

ブロックの情報

Created by machine info using machine_info.get_block_info(...).

field type
position function (no args; returns vector)
forward function (no args; returns vector)
right function (no args; returns vector)
up function (no args; returns vector)
rotation function (no args; returns vector)
being_vacuumed function (no args; returns boolean)
id function (no args; returns int)
build_index function (no args; returns int)
health function (no args; returns number)
burning function (no args; returns boolean)
flipped function (no args; returns boolean)
frozen function (no args; returns boolean)
in_wind function (no args; returns boolean)
destroyed function (no args; returns boolean)
zero_g function (no args; returns boolean)
original_mass function (no args; returns number)
scale function (no args; returns vector)
velocity function (no args; returns vector)
angular_velocity function (no args; returns vector)

Machine Info

マシンの情報

Created by machine using machine.get_machine_info(...).

field type
get_block_info (local machine only) function (args: string ref_key, int index_of_all (optional); returns block info)
get_block_info (both local and another player`s machine) function (args: int build_index; returns block info)
block_count function (no args; returns int)
cluster_count function (no args; returns int)
center function (no args; returns vector)
mass function (no args; returns number)
middle function (no args; returns vector)
name function (no args; returns string)
player_id function (no args; returns int)
player function (no args; returns player info)
position function (no args; returns vector)
rotation function (no args; returns vector)
velocity function (no args; returns vector)
angular_velocity function (no args; returns vector)
size function (no args; returns vector)
unbreakable function (no args; returns boolean)
infinite_ammo function (no args; returns boolean)
is_dragging_blocks function (no args; returns boolean)
team function (no args; returns int)
is_simulating function (no args; returns boolean)

Raycast Hit

レイキャストのヒット判定

Created by physics using physics.raycast(...).

field type
distance number
point vector
normal vector
is_block boolean
get_block_info function (no args; returns block info)

Collider

コライダー

Created by physics using physics.overlap_sphere(...).

field type
is_block boolean
get_block_info function (no args; returns block info)

Line Renderer (WIP)

線の描画

Created by lines library using lines.new_line_renderer().

field type
set_points function (vector start, vector end; void)
set_width function (number start_size, number end_size; void)
set_color function (vector color; void)

Shape

Created by shapes library using shapes.new_...().

field type
set_position function (vector position; void)
set_rotation function (quaternion rotation; void)
set_scale function (vector scale; void)
set_color function (vector color; void)

Player Info

Created by players library using players.get(...) and other.

field type
in_local_sim function (no args; returns boolean)
is_host function (no args; boolean)
is_local_player function (no args; returns boolean)
is_spectator function (no args; returns boolean)
is_simulating function (no args; returns boolean)
name function (no args; returns string)
id function (no args; returns int)
team function (no args; returns id)
get_machine_info function (no args; returns machine info)

Level Entity

Created by entities library using entities.get(...) and other.

field type
position function (no args; returns vector)
rotation function (no args; returns vector)
scale function (no args; returns vector)
velocity function (no args; returns vector)
is_destroyed function (no args; returns bool)
id function (no args; returns int)
name function (no args; returns string)
category function (no args; returns string)
team function (no args; returns int)
max_health function (no args; returns number)
health function (no args; returns number)

Mod libraries

注意！関数がテーブルを返すたびに、そのテーブルに参照を返すのではなく、新しいテーブルを作成します。つまり、fixed_updateループの中では、block_infoのような大きなテーブルは作ってはいけません。代わりに、スクリプトの先頭やplayコールバックでblock info を作成するようにしてください。

Math

math

Math library.

function arguments return values
abs number x number
acos number x number
asin number x number
atan2 number y, number x number
atan number x number
ceil number x number
cosh number x number
cos number x number
deg number x number
exp number x number
floor number x number
fmod number x, number y number,
frexp number x number, number
ldexp number x, number y number
log10 number x number
log number x, number base (optional) number
max multiple number arguments number
min multiple number arguments number
modf number x number, number
pow number x, number y number
rad number x number
random number
random number upper number
random number lower, number upper number
randomseed number seed void
sinh number x void
sin number x number
sqrt number x number
tanh number x number
tan number x number
lerp number a, number b, number t number
inverse_lerp number a, number b, number t number
lerp_unclamped number a, number b, number t number
lerp_angle number a, number b, number t number
clamp number a, number min, number max number
clamp01 number a number
approximately number a, number b bool
round number x number
closest_power_of_two number x number
delta_angle number a, number b number
gamma number value, number absmax, number gamma number
gamma_to_linear_space number x number
linear_to_gamma_space number x number
move_towards number current, number target, number max_delta number
is_power_of_two number x bool
perlin_noise number x, number y number
ping_pong number t, number length number
repeat number t, number length number
sign number x number
smoothstep number from, number to, number t number

Rectangle

矩形

rect

GUI で使います。

function arguments return values
new int x (optional), int y (optional), int width (optional), int height (optional) rectangle

Texture

texture

Used by GUI library.

function arguments return values
from_base64 string base64_image number texture_ref

Graphical user interface

gui

GUI ライブラリは UnityEngine.GUI クラスをベースにしていますが、引数が変更されたクラスもあります。詳しくはUseful Linksの Unity Scripting API を参照してください。

function arguments return values
world_to_screen_point vector world_position vector
draw_texture rectangle position, number texture_ref
rotate_around_point number angle, vector point
scale_around_point vector scale, vector point
label rectangle position, string text
button rectangle position, string text boolean
toggle rectangle position, boolean value, string text boolean
begin_group rectangle position
begin_scroll_view rectangle position, vector scroll_position, rectangle view_rect
box rectangle position, string text
bring_window_to_front int window_id
bring_window_to_back int window_id
drag_window
end_group
end_scroll_view
focus_control string name
focus_window string name
get_name_of_focused_control string
horizontal_scrollbar rectangle position, number value, number size, number left_value, number right_value number
horizontal_slider rectangle position, number value, number left_value, number right_value number
modal_window (arguments were changed) int id, rectangle clientrect, string text, _function (args: int window_id; void) rectangle
password_field rectangle position, string password, char mask string
repeat_button rectangle position, string text boolean
scroll_to rectangle position
selection_grid rectangle position, int selected, string array texts, int x_count int
set_next_control_name string name
text_area rectangle position, string text string
text_field rectangle position, string text string
unfocus_window
vertical_scrollbar rectangle position, number value, number size, number top_value, number buttom_value number
vertical_slider rectangle position, number value, number top_value, number buttom_value number
window (arguments are changed) int windowid, rectangle client_rect, string title, _function (args: int window_id; void) rectangle

Vector

vector

Basic Vector4 library based on UnityEngine.Vector4. See Unity Scripting API about Vector4 in Useful Links.

function arguments return values
new number w (optional), number y (optional), number z (optional), number w (optional) vector
distance vector a, vector b number
dot vector a, vector b number
lerp vector a, vector b, number t vector
lerp_unclamped vector a, vector b, number t vector
magnitude vector a number
max vector lhs, vector rhs vector
min vector lhs, vector rhs vector
move_towards vector current, vector target, number max_distance_delta vector
normalize vector a vector
project vector a, vector b vector
scale vector a, vector b vector
add vector a, vector b vector
subtract vector a, vector b vector
negative vector a vector
multiply vector a, number b vector
equals vector a, vector b boolean
angle vector from, vector to number
clamp_magnitude vector a, number max_length vector
cross vector a, vector b vector
project_on_plane vector point, vector normal vector
reflect vector in_direction, vector in_normal vector

Quaternion

quaternion

Basic Quaternion library based on UnityEngine.Quaternion. See Unity Scripting API about Quaternion in Useful Links.

function arguments return values
new number x (optional), number y (optional), number z (optional), number w (optional) quaternion
new vector vector quaternion
euler number x (optional), number y (optional), number z (optional) quaternion
euler vector vector quaternion
angle quaternion a, quaternion b number
angle_axis number angle, vector axis quaternion
dot quaternion a, quaternion b number
from_to_rotation vector from_rotation, vector to_direction quaternion
inverse quaternion a quaternion
lerp quaternion a, quaternion b, number t quaternion
lerp_unclamped quaternion a, quaternion b, number t quaternion
slerp quaternion a, quaternion b, number t quaternion
slerp_unclamped quaternion a, quaternion b, number t quaternion
look_rotation vector forward, vector upwards quaternion
rotate_towards quaternion from, quaternion to, number max_degrees_delta quaternion
multiply quaternion a, quaternion b quaternion
multiply_on_vector quaternion a, vector b vector
equals quaternion a, quaternion b boolean

Machine

マシン

machine

キーのエミュレート、スライダとステアリングの制御、マシン情報のためのライブラリ。

function arguments return values
new_key_emulator string key_code key emulator)
get_refs_control string ref_key refs controller)
get_machine_info machine info)

Input

入力

input

キーボード、マウス、ジョイスティックなどから直接入力を行うためのライブラリ。詳しくはUseful Linksの Unity Scripting API を参照してください。

function arguments return values
mouse_screen_position vector
mouse_raycast_hit_point vector
mouse_raycast_hit raycast hit
get_axis string axis number
get_axis_raw string axis number
get_key string key_code boolean
get_key_down string key_code boolean
get_mouse_button int mouse_button boolean
get_mouse_button_down int mouse_button boolean
get_mouse_button_up int mouse_button boolean
any_key boolean
any_key_down boolean
mouse_scroll_delta vector
main_camera_position vector

Cursor

カーソル

cursor

マウスカーソルのライブラリ。

function arguments return values
set_state boolean state

Physics

物理

physics

物理関係の情報を得るためのライブラリ。詳しくはUseful Linksの Unity Scripting API を参照してください。

function arguments return values
raycast vector origin, vector direction raycast hit
overlap_sphere vector origin, number radius, int layer_mask (optional) collider array
overlap_box vector center, vector half_extents, quaternion rotation (optional), int layer_mask (optional) collider array
overlap_capsule vector point0, vector point1, number radius, int layer_mask (optional) collider array
check_sphere vector origin, number radius, int layer_mask (optional) bool
check_box vector center, vector half_extents, quaternion rotation (optional), int layer_mask (optional) bool
check_capsule vector point0, vector point1, number radius, int layer_mask (optional) bool
sphere_cast vector origin, vector direction, number radius, number max_distance, int layer_mask (optional) bool
box_cast vector center, vector half_extents, vector direction, number max_distance, quaternion rotation (optional), int layer_mask (optional) bool
capsule_cast vector point0, vector point1, number radius, vector direction, number max_distance, int layer_mask (optional) bool
line_cast vector stard, vector end, int layer_mask (optional) bool
gravity vector

Players

プレイヤー

players

マルチプレイのセッションの情報を得るためのライブラリ。

function arguments return values
count int
get int player_index player info
by_id int network_id player info
get_all player info array

Lines

lines

線を描画するライブラリ（ローカルのみで動きます）。

function arguments return values
new_line_renderer line renderer

Shapes

shapes

Library for drawing 3D debug shapes (only local client).

function arguments return values
new_sphere vector position, quaternion rotation, vector scale, vector color, shape
new_capsule vector position, quaternion rotation, vector scale, vector color, shape
new_cylinder vector position, quaternion rotation, vector scale, vector color, shape
new_cube vector position, quaternion rotation, vector scale, vector color, shape
new_plane vector position, quaternion rotation, vector scale, vector color, shape
new_quad vector position, quaternion rotation, vector scale, vector color, shape

Screen

画面

screen

ゲーム画面の大きさなどの情報を得るためのライブラリ。

function arguments return values
width number
height number
fullscreen boolean
dpi number

Chat

チャット

chat

チャットメッセージを操作したり、書いたりするためのライブラリ。

function arguments return values
add_listener function (args: string sender, string text; void)
set_visible boolean state
write_local string text
write_team string text
write_global string text
clear

Level Entities

entities

Library for getting information about level entities (works only with level editor and multiplayer).

function arguments return values
count int
get_all entity array
get_all_by_name string name entity array
get_all_by_id int id entity array
get_all_by_category string category entity array
get_all_in_sphere vector origin, number radius entity array
get_nearest vector origin entity
get_nearest_alive vector origin entity

Time

time

function arguments return values
time number
delta_time number
fixed_delta_time number
time_scale number

読んでくれてありがとう！

Clone this wiki locally