User:Anaminus/Doc:ScriptBuilder

Script Builder Help

This is the basic documentation to the ever popular Script Builder.

General

These are the general commands used in script builder.

Location: //SB/

Edit Mode

These commands are used while in edit mode.

Location: //SB/edit/

Library

Basic Commands

These commands are used while browsing the library.

Location: //SB/library/

Section Commands

These commands are used while browsing the Script section or the Call section of the library.

Location: //SB/library/script/ ; //SB/library/call/

Tool Extension

The tool extension helps you create a custom tool.

To make a custom tool, first create the script you want to use with it. (This will be the source)

To run the tool extension, call "Tool" with the get/ command (get/Tool).

These commands are used while using the tool extension.

Location: //SB/library/call/Tool/

Global Functions

These are global functions that are enabled in script builder.

You do not need to add functions to your script for these to work. You call them just like any other global function (print or wait).

Location: //_G/

THESE FUNCTIONS WILL BE DEPRECATED IN THE NEXT VERSION!!

Remove(object)

Removes object if it can legally be removed.

Note! You must specify the entire directory of the object if you want it to be removed!

Remove(game.Workspace.Part.Script)
					--> Works

game.Workspace.Part.Script:Remove()
					--> Doesn't work

game.Workspace.Part.Remove(Script)
					--> Doesn't work

game.Workspace.Part:Remove(Script)
					--> Doesn't work.

s = game.Workspace.Part.Script
Remove(s)
					--> Works

p = game.Workspace.Part
Remove(p.Script)
					--> Works

p = game.Workspace.Part
p:Remove(Script)
					--> Doesn't work

Remove(object) replaces object:Remove() or object.Parent = nil

Clone(object)

Returns a clone of object if it can legally be cloned.

Note! You must specify the entire directory of the object if you want it to be cloned!

c = Clone(game.Workspace.Part.Script)
					--> Works

c = game.Workspace.Part.Script:Clone()
					--> Doesn't work

c = game.Workspace.Part.Clone(Script)
					--> Doesn't work

c = game.Workspace.Part:Clone(Script)
					--> Doesn't work.

s = game.Workspace.Part.Script
c = Clone(s)
					--> Works

p = game.Workspace.Part
c = Clone(p.Script)
					--> Works

p = game.Workspace.Part
c = p:Clone(Script)
					--> Doesn't work

Clone(game.Workspace.Part.Script).Parent = game.Workspace
					--> Works

Clone(object) replaces object:Clone()

SetSource(script,source)

Sets the source of script to source.

Note! You must specify the entire directory of the script if you want the source to be set!

SetSource(game.Workspace.Part.Script,"-- Hello World!")
					--> Works

game.Workspace.Part.Script.Source = "-- Hello World!"
					--> Doesn't work

SetSource(game.Workspace.Part.Script,[[
print("Hello World!")
]])
					--> Works

s = game.Workspace.Part.Script
SetSource(s,[[
print("Hello World!")
]])
					--> Works
s = game.Workspace.Part.Script
s.Source = [[
print("Hello World!")
]]
					--> Doesn't work

SetSource(script,source) replaces script.Source = source

GetSource(script)

Returns the source of script.

Note! You must specify the entire directory of the script if you want to get the source!

source = GetSource(game.Workspace.Part.Script)
					--> Works

source = game.Workspace.Part.Script.Source
					--> Doesn't work

s = game.Workspace.Part.Script
source = GetSource(s)
					--> Works
s = game.Workspace.Part.Script
source = s.Source
					--> Doesn't work

GetSource(script) replaces var = script.Source

In-game Help

The following are optional arguments used with the help/argument command..

Location: //SB/help/

Arguments

Argument	Info	Command
(none)	General information.	help/
edit	Information about edit mode.	help/edit
library	Information about the library.	help/library
tool	Information about the tool extension.	help/tool
global	Information about the global functions.	help/global