Skip to content

Commit 73a1cca

Browse files
committed
Resolve feedback comments
1 parent 9f06a70 commit 73a1cca

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

content/docs/world/scripting.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ For reasons, custom code must either be generated by rebuilding the client (i.e.
99
## How to Add Scripts Via Unity Client Build
1010

1111
<Callout type="info">
12-
If you are creating an application using the Basis framework, and user-generated content such as props, avatars and scenes are *not* important to it (for example, if you are building a casual multiplayer shooter game), you might prefer to build via client instead of using Cilbox. This is because Cilbox is a Virtual Machine (VM) so most code executed within it will typically be (much) less less performant.
12+
13+
If you are building a game or application with the framework, and supporting user-generated content (such as scenes, avatars, or props) is not a priority, you may prefer to build your MonoBehaviour scripts natively rather than leveraging Cilbox.
14+
15+
This is because Cilbox is a CIL interpreter, which will incur a significant speed penalty and may support a subset of available language features.
1316
</Callout>
1417

1518
- Create a canvas object with a button inside it.
@@ -162,12 +165,12 @@ You should disable or remove the canvas object from the scene. This is because k
162165

163166
## How to Add Network Syncing Scripts Via Cilbox
164167

165-
Cilbox is a scripting system to act as glue to help provide some minimal game logic, enabling portability of basic behaviours in user-generated content such as props, avatars, and scenes. It can be used to create scripts that work in runtime.
168+
Cilbox is a scripting system to act as glue to help provide some minimal game logic, enabling portability of basic behaviours in user-generated content such as props, avatars, and scenes. It can be used to create scripts that work at runtime.
166169

167-
Currently, Cilbox is still quite experimental. The following example shows how to create a script to make a cube rotate using Cilbox.
170+
Currently, Cilbox is still very experimental. The following example shows how to create a script to make a cube rotate using Cilbox.
168171

169172
<Callout type="info">
170-
Note: Cilbox is especially useful if you are making an application that hosts user content, and want to support scripting on that user content. It allows shipping scripts as essentially DLC while also providing a more secure sandbox for code to be executed within, preventing scripts with harmful or undesirable behaviours from executing.
173+
Note: Cilbox is especially useful if you are making an application or game that loads user-generated content, and want to support scripting on that user content. It allows shipping scripts as something like DLC alongside your other content, while also providing a more secure sandbox for code to be executed within, preventing scripts with harmful or undesirable behaviours from executing.
171174
</Callout>
172175

173176
- Create a cube object and an ObjectRotator component to attach to it. Make sure to add [Cilboxable] above your class.

0 commit comments

Comments
 (0)