Platinum Arts Sandbox Free 3D Game Maker - User contributions [en]

Installing Platinum Arts Sandbox

2011-07-18T06:59:47Z

Porterking:

This article explains how to install Platinum Arts Sandbox

== Obtaining Sandbox ==

You will first have to [http://kids.platinumarts.net/download-sandbox.html download the latest release]. If it fails to load after you tried the instructions below, please read our [http://kids.platinumarts.net/wiki/index.php?title=FAQ Frequently Asked Questions]

== Installing the Windows version ==

When you click on the downloaded file it will ask you where you want to install Sandbox. If you click the three dots to the right you can browse your computer and select where you'd like to place sandbox. After you are satisfied with where it is to install hit extract. The sandbox folder will then be created where you chose to install it. Locate the folder and enter it. Click on the file that says "'''(clickheretostart)'''" and it should launch. To launch the carts click on the file that says "cartmode".

== Installing the multi-platform version ==

The multi-platform version works on Windows, Linux and Mac.

=== Linux ===

To install Sandbox in a Linux based operating system, simply download the latest sandbox multi platform zip we have available and extract it into a directory of your choice, then use chmod +x to give sandbox_unix or _SandboxLauncher executable permissions, (for the non console savvy, GNOME and KDE allow these changes on the file's properties screen). the sandbox_unix script will take care of permissions, so you may wish to run it first before resorting to the launcher.

If you wish for a system wide install, one that'll require you to only type 'sandbox' followed by any desired command line options to run the program, go into the src directory and give the install.sh script executable permissions, and then run it, it'll set everything up for you. Note: all your files will, from here on out, be saved in ~/.platinumarts.

The Makefile contains a wrapper for this, "make distinstall", if there's any problems, see the [[Compiling_the_source_code|compilation page]].

==== Debian/Ubuntu ====

Platinum Arts Sandbox Game Maker is included in Debian 6.0 (Squeeze), Ubuntu 10.10 (Maverick), and later releases. It will be in the contrib and multiverse repositories, respectively. The packages can be installed through apt-get, aptitude, synaptic, etc. The package will install links in the application-> games menu. From the command line, type "sandbox_unix_usr -h" for options on how to use.

In Ubuntu you can also install through the "Ubuntu Software Center."

Additional information and notes [http://forum.sandboxgamemaker.com/viewtopic.php?f=8&t=933&p=4952#p4952 on the forum].

Ubuntu users can also retrieve the packages from [http://www.playdeb.net playdeb.net]. see [http://www.playdeb.net/updates/Ubuntu/all#how_to_install here] for use instructions

=== OSX ===

We'll leave it to you, chances are you'll want to put it in the applications, but first, before you do that, you'll have to compile your own binaries until we can provide them for.

== Related ==

*[[compiling the source code]]
*[[Bug reports]]
* [[development|Obtaining development version]]
* [[Cooperative Editing]] (server setup)

[http://customcollegeessays.com/index.php college essay]

Good free programs for Sandbox

2011-07-18T06:59:42Z

Porterking:

All the below programs are free:

Wings3d, a great modeler with a outstanding uv mapper.

http://www.wings3d.com/

Tattoo 3D, This was my first 3D texturing program. It great for fast texturing but limited on more powerfull functions as it a older program. Free to use for non-commerical work.

http://www.terabit-software.co.uk/

Blacksmith 3D, You can paint your models in realtime 3D. The "freeware" 3D painter limits your export image size to 1024 x1024 which is more than enough for Sandbox

http://www.blacksmith3d.com/blacksmith3D-3d-paint-software.php

Artweaver, a 2d paint program like photoshop. It supports layers. Some texture artist like to paint on the flat 2D uv map image for textuing and other texturing usage.

http://www.artweaver.de/index.php?en_version

Misfit Model 3D, to add bones and animations for your NPC or other models, plus to save your model as a md3 file with the animation data. be sure to get the lastest beta version

http://www.misfitcode.com/misfitmodel3d/

CharactorFx, for adding bones and animation to your models. It's a little older program but works great and saves to md2 files.

http://www.insanesoftware.de/

MD3Compile, a very quick and easy converter for md2,3ds files to a md3 file. I use it for converting my static 3ds models into a md3 file plus to rebuild my 3ds model's normals.

http://www.quakeunity.com/file=481

Notepad Plus (++), unique text tool built mainly for scripting of many different types. This can be used to edit/make CFGs in Sandbox.

http://notepad-plus.sourceforge.net/uk/site.htm

[http://essaywritingservices.org/prices.php write my paper]

FPS

2011-07-18T06:59:37Z

Porterking:

FPS(First Person Shooter) Mode
FPS mode is the default mode. It doesn't have a lot of special features like the other modes, including spells, advanced interaction, platforming levels, etc. It's the mode to make Shooters. It's also a TPS (Third Person Shooter) though too. E is used for edit mode instead of RPG's F1

F2:Brings up the texture menu.

F3:Brings up the materials menu.

F4:Brings up the sky menu.

Space:Jump

W, A, S, D :to move around. Also arrow buttons.

Esc:Brings up the main menu.

[http://essaywritingservices.org/prices.php write my essay]

FAQ

2011-07-18T06:59:31Z

Porterking:

A list of questions we've been asked and the answers too them<br>
This is still an FAQ as the order of the questions and answers will be rearranged periodically based on the frequency they've been asked

You may wish to use Ctrl-F with a few keywords (eg model) to find your query with a common solution faster

= General =

== '''The game starts up, and closes shortly afterwards''' ==

This is sort of an ambiguous situation, read carefully

:'''A1:''' If you saw a message similar to, could not load core textures, you're trying to run the bin directly, or in the wrong directory. please use the sandbox_unix bash script, or the click_me_to_start batch, or the Launcher.
:'''A2:''' You might have broken/corrupt drivers. Please install the newest ones provided by your GPU (aka, video card) manufacturer, especially if you use windows, since Microsoft's default OGL (WGL) implementation is horrible and is hardly capable of running sandbox.
:'''A3:''' Your graphics card might not have shader support, though sandbox should automatically turn it off, if it doesn't, use the launcher turn shaders off. Otherwise in linux enter -f in the launch command. On windows, open CLICK_ME_TO_START.bat with notepad (or you can right click the file and select edit) and add -f after the sandbox.exe Note: If given a number (f1 or f2), it'll set the shader quality to that value.
:'''A4:''' If you have an '''ATI card''' you might need to do this "I found that it wont run unless you disable the Catalyst A.I. After i did that it loaded right up! Hope this helps anyone that has problems running sandbox." Thanks Fudwumper!!

== '''I have really low FPS and/or bad performance, what do I do?''' ==

:'''A1:''' Make sure you update your graphics card drivers. Also just because you have a new computer doesn't mean you have the latest graphic cards drivers.
:'''A2:''' Lower the resolution
:'''A3:''' Try turning shaders off

== '''I am unable to utilise Alt-TAB or similar functionality''' ==

This only applies to non-Windows systems.

This is due to inane behavior inside SDL. Whenever the window is set to fullscreen using SDL_SetVideoMode, SDL takes exclusive control of your keyboard. SDL Also takes exclusive access of your mouse if SDL_ShowCursor(0) is called (this disables acceleration and breaks everything if the pointer is reliant on absolute positioning).
Whilst fullscreen with SDL hogging all input, you can not send any input events to anything but the SDL application, with the exception of exclusive events meant for the kernel and events meant for whatever allows SDL such access.

So basically if you don't wish to be afflicted by this stupidity, run sandbox in windowed mode. This can be achieved by using the [[Cmdline_arguments| -t command line option]], manually entering /fullscreen 0 in game or toggling the option in the options menu.<br>
Linux/FreeBSD users can also opt to start sandbox in windowed mode and change it to fullscreen using your window manager. For example using KDE + Kwin, right click the title or press alt - F3, go to advanced and select fullscreen.

== '''Are there weapons in Sandbox?''' ==

Sandbox is intended to be kid friendly. In the RPG there is "action" with a melee vegetable extractor and spells. Also we will be doing a child friendly squirt gun battle mode. However if someone wanted to make adult violence from the rpg and water gun mode they certainly could though that is not our current focus.

=='''How do I edit/play MULTIPLAYER with my friends/other people?'''==

Our next release will include a master server so people can see all the servers available, but currently you need to directly connect to the server. For instructions on how to do this and how to set up a server [http://sandboxgamemaker.com/wiki/index.php?title=Cooperative_Editing please see this link].

== '''How do I add my own models and characters to Sandbox?''' ==

Please see the [[Adding_Models_to_Sandbox]] page for tutorials on model creation and bringing your creations into Sandbox.

=='''My Mouse only has 1 button''' ==

:This means you don't have access to a scroll wheel, which is mostly referred to as universal delta in the documentation.
:'''A1:''' go into options and click the "''PG UP and PG DN as universal delta''"
:'''A2:''' delete config*.cfg and open data/defaults.cfg and modify the mouse4 and mouse 5 binds, mouse 2 and 3 (right and wheel clicks respectively) are mostly for convenience and not nearly as important as the wheel.
:'''A3:''' Obtain a mouse with a scroll wheel :P

= Editing =

=='''How do I add an NPC to the game?'''==

Take a look at village.cfg and savetheprincess.cfg which are located in the packages/base folder. You can open them with a text editor such as notepad or wordpad. If you check out where the models are listed you'll notice near the end of the savetheprincess.cfg that there is mmodel rc/pink This is the princess. To add this to your own map you can either copy this config and rename it to exactly what your map is named, or you can create your own config and add it at the bottom of the list. To create your own config all you have to do is create a new text document, name it exactly how your map is spelled and change the .txt at the end to .cfg [http://www.svn.kids.platinumarts.net/32pas32/trunk/packages/base/fps/savetheprincess.cfg Savetheprincess.cfg for reference]

=='''How do I make an NPC talk and/or give quests?'''==

Review the previous question on how to add the npc. If you look at the savetheprincess.cfg you'll notice this
level_trigger_1 = [showgui Princess-Robochimp]
newgui Princess-Robochimp [
guitext "Thank you for saving me!" chat
guitext "You're my hero!" chat
]

That is the format for making a character talk. You can copy and modify that code according to what you'd like your character to say. Now you need to into the map and fly over to Princess robochimp. In edit mode click on her and then press . Make sure to press enter after you've made your modifications to save the entity. If you set the 3rd attribute to 1 she'll talk once, if set at 11 she'll talk each time she is approached. For the 4th attribute it needs to be set to 1 to correspond to the code in the config. If it was level_trigger_2 in the config then that 4th attribute would need to be 2. If notice in Savetheprincess the 1 1 values to make her talk are actually in an invisible model close to her. This is so that it shows her idle animation (jumping with the arms up). To make a model invisible set the 2nd attribute to 0. Setting up quests works in a similar fashion, check out village.cfg and take a look at the quest code. Try changing it to what you are looking to do. For a version that isn't so complicated [http://sandboxgamemaker.com/villageold.cfg check out the old version of village.cfg] that I modified to be a quest to find five keys.

=='''How do I make items that can be picked up?'''==

Please review the previous question. The third attribute needs to be 12 and then it will be picked up.

=='''How do I add creatures such as butterflies to my map'''==

:Type /newent creature 0-6 Note: 0 is the butterfly, 1 the dragon, etc
:note if you're using 2.2.0 or older, it's /newent monster

=='''How do I light my map?'''==

A basic way to do it is first select an area on the map where you want to place it. Then go to the new light menu. Make sure you select a color and a radius and then select create light. You can either enter /calclight in the console or you can go to editing gui and then lighting and select what options you want when creating your lights. Finish the process and your map will be lit according to the light you created :) [http://www.kids.platinumarts.net/wiki/index.php?title=Lighting Check here for more detailed information]

=='''The lights aren't working'''==

:'''A1:''' Check if you placed any lights inside mapmodels or geometry
:'''A2:''' Did you calculate lightmaps? ie, the /calclight and /patchlight commands
:'''A3:''' Does the light have a very small radius, or RGB values of 0? ie light 256 0 0 0 won't make any light, light 256 200 100 50 should emit a relatively bright orange.

=='''How do I make sloped "roofs" like those in house?'''==

Note, this refers to sloped geometry in general

:'''A1:''' Hold the middle mouse button, and selected the vertices (point were 2 or more edges meet) you wish to edit, and scroll up/down to deform the cube
:'''A2:''' Select 1 or more cubes, and hold in Q. Scroll while hovering over a vertice to deform that specific vertice in the whole selection
:'''A3:''' select 1 or more cubes, and hold F. Scroll the wheel to deform the whole face (collection of 3 or 4 vertices, note computers are limited to triangles and quadrilaterals, a circle for example is a series of triangles).

=='''How do I create grass?'''==

First make sure grass is turned on! (/grass 1)

Hold the Y button down and scroll with the mouse wheel until you come to the texture that includes the 3D grass. To change what texture the grass is linked with check /data/default_map_settings.cfg

To add grass, add a autograss "texture" to a texture's loading statement

=='''How do I create rain or snow?'''==
To add a water particle entity to the map:

:Type /newent particles 10 300 256 868 1000 in the console

10 is the type, 300 the shape, 256 the radius, 868, a 12 bit colour, 1000 the fading time

To add snow particles entity to the map:

:Type /newent particles 12 300 256 0xFFFFFA 10000 0 0 0

=='''I can't see my custom mapmodels'''==
:'''A1''' Check that the mmodel command of the model you're trying to load points to a valid object, relevant to packages/models, if you use windows, just invert the slash (note that the model listings are generated automatically on mapsave from 2.3 onwards)
:'''A2''' is there a tris.* present? or a md*.cfg or an obj.cfg loading the current model if it isn't named tris.*?
:'''A3''' note that mmodel is directed to a directory, not to the model file

=='''How do I edit my map's configuration'''==
:'''A1''' use an external file editor like notepad or kate to open the respective map configuration
:'''A2''' enter editmode, and press F6, then the load button in the GUI that appears

'''Is there any program to make editing easier?'''

:'''A1''' Yes, It's called Notepad++. You can download it here http://notepad-plus.sourceforge.net/uk/site.htm

= Other =

=='''Are there any sandbox user groups?'''==
:In short no, if there are any, we're not aware of them

=='''Can I use sandbox maps in (insert fave game here)'''==
:In most cases this can't be done, unless the engine you're using happens to be cube 2, or has support for the cube 2 octree map format. However you can export the map geometry to .obj format using the command /writeobj

[http://essaywritingservices.org/index.php essay writing service]

Cubescript

2011-07-18T06:59:23Z

Porterking:

Cubescript is the scripting language utilised within the sauerbraten/cube2 engine. it is used to set aliases, variables, create binds and generate the menu.

=Writing in Cubescript=

==Aliases==

The brunt of cubescript is concerned with Aliases. Aliases have 3 basic uses.
* store lists and values for extended periods of time
* store temporary lists and values
* grouping a set of commands which are useful when combined

There are two ways to declare an alias. You can do it via infix notation, or by using the alias command. It should be noted that aliases are the exception to the rule, infix notation is only available for creating aliases.

A VERY important note, alias specific operations are available to aliases only. this means builtin variables can't be set or overridden through alias, =, pop and push (among others).

<code>
//command
alias myalias [1]

//infix variant
myalias = [1]
</code>

===executing aliases===

To execute an alias, you execute it like any other command. if I had an alias named '''myalias''', I would simply invoke ''''/myalias''' to execute it.

These aliases also have access to a class of special aliases. Those are the temporaries in which arguments are stored. There's also a useful variable named 'numargs' which tell you how many arguments were provided. The aliases containing the arguments are named arg. they are numbered and enumerated, starting from 1, so you'd use $arg1 to access the first argument. This does not start at 0, since arg0 is the command's name (arg0 is also not defined.. ever, nor included in numargs).

<code>
//prints all arguments to screen, one by one
//see the other comments for an explanation

print = [ //declares an alias named print
loop i $numargs [ //loops $numargs times, setting i to the current iteration
echo (getalias (concatword arg (+ $i 1)) //gets the value of the arguments, by accessing $arg1 $arg2 $arg3....
] //close loop
] //close print alias
print I like unicorns //should print I like unicorns on 3 separate lines
</code>

===push and pop===

Push and pop used to be two separate instructions, but since the advent of the new Cubescrpt interpreter/compiler (2.6.1), they have been merged into a single instruction. The syntax for this singular stack manipulation command is as follows.

push variable value body

The stack is automatically popped after execution

<code>
myalias = "candy"
push myalias "lollipops" [
echo $myalias
]
echo $myalias

//expected output
//lollipops
//candy
</code>

==Syntax==

Cubescript is not your typical scripting language. Cubescript is not the most flexible, or the best language, but it more than adequate for our needs and purposes. Cubescript draws its main inspiration from quakescript and from Lisp. It is therefor said that Cubescript contains many "Lispisms". Below is a summary of notable features/quirks.

* comments are denoted by //
* both newlines and ; denote the end of a call.
* newlines will automatically close of any strings you may have forgotten to. (you should not rely on this)
* substitutions are done through the use of $ and @ tokens, (See below)
* everything is a function which may take arguments. With the exception of setting an alias, infix notation does not exist
* there are no arrays or vectors, only lists.
* most implementations have a 25 word limit. This means commands can be invoked with up to 24 arguments

one liner example

<code>
alias hi [say "hi"; sleep 5000 [say "Hi again"]]
</code>

multi liner example

<code>
alias hi [
say "hi"
sleep 5000 [
say "Hi again"
]
]
</code>

it's obvious what the above code does, it'll make your character say hi, and wait 5 seconds before saying hi again.

indenting is done in levels, the Tabulator (TAB) key is usually used to indent the text. while not necessary, it tends to make it bigger, and more legible as seen in the above example (when you get to big stuff, you'll thank yourself for indenting it.

As a rule of thumb, pretty much only [ increases the indentation level. Also note, ", ] and ) can close each other, so make sure you close them off properly

==containers==

Containers in cubescript are of 3 specific types, "", () and [] - all of these have significant differences in operation and use

==="" container===

"" containers are used to store things EXACTLY as they are written, with a few small exceptions - in-text commands which are denoted by a preceding ^. They are as follows

* ^f#
** ^f# is used to colour text. # must be replaced by either a number or a capital letter (A-Z). r and s are special control characters which will restore and save the text's current colour respectively.
* ^n
** insert a '\n' character (newline/linefeed)
* ^t
** inserts a '\t' character (tabulator)
* ^"
** inserts a quote (")

===() container===

() containers are used mainly for logic/arithmetic operations. They are usually nested inside [] blocks, and unless they are nested inside []'s they're permanently substituted with their results.

For example - the following will turn into an infinite loop. The condition is initially evaluated and substituted with one and since 1 can never = 0, it's true forever more

<code>
i = 0
while (= $i 0) [i = (+ $i 1)]
</code>

the following code on the otherhand is devoid of such issues. Being nested inside the [] means it's not substituted and evaluated each cycle

<code>
i = 0
while [= $i 0] [i = (+ $i 1)]
</code>

===[] container===

This container is used for nesting, deferring execution of it's contents, deferring calculations and substitutions of () containers, and substitutions of aliases/variables written with a @ prefix (note several levels are needed to achieve this). [] containers are also the ONLY container capable of spanning multiple lines.

This is the most used container and due to it's properties, is ideal for creating aliases.

generally statements in cubescript can't span multiple lines. If you should use this container and occupy several, the execution of the prior command continues exactly where this container finished off. This can be demonstrated with an if statement.

<code>
if 1 [
do
stuff
] [
do
other
stuff
]
</code>

==substitution==

there are two principle ways of substituting values in cubescript, the first is through the use of $ tokens, the second is through the use of @ tokens.

a very simple example:
<code>
myalias = 5
echo $myalias
</code>
myalias is substituted into the echo statement, so you should see 5 printed to the top-left of the screen

using the @ token would have also resulted in the same behaviour
<code>
myalias = 5
echo @myalias
</code>

There's a big difference between the two, the @ token can be used to concatenate stuff together, $ can't. @ is also substituted immediately up to the first level of nesting. (this can be incremented by using additional @ tokens, ie @@ for 2 levels of nesting). Do take note that too few @ tokens may cause a substitution to happen too late, and too many may likewise cause it to happen too early.

'''An example of use in a level 1 nest'''

<code>
myalias = "I am awesome"
mymenu = [guitext @myalias]
</code>
if you were to type /echo $mymenu, it should read: guitext "I am awesome"; using the $ token on the other hand

<code>
myalias = "I am awesome"
mymenu = [guitext $myalias]
</code>
typing /echo $mymenu should produce: guitext $myalias

'''An example of concatenation'''

as i mentioned, @ also allows you to concatenate stuff together, which could result in shorter and simpler scripts. It should be noted that this can also result in extreme obfuscation
<code>
myalias0 = 5
myalias1 = 3.1415
myalias2 = 2.481

loop i 3 [
echo $myalias@i
]
</code>
this should print 5, 3.1415 and 2.481 respectively

the purely $ token equivalent
<code>
myalias0 = 5
myalias1 = 3.1415
myalias2 = 2.481

loop i 3 [
echo (getalias (concatword myalias $i))
]
</code>

'''Lookup of a Lookup'''

There are two ways to look up multiple things; the first is by encasing it inside 'getalias', the second involves using multiple lookup tokens. There is a caveat with the second method, while it works on more types, it's only available in sandbox as of 2.6.1.

All 3 of the below examples should print "victory!"
<code>
alias1 = "alias2"
alias2 = "alias3"
alias3 = "victory!"

//the first method
echo (getalias (getalias $alias1))

//the second method; 2.6.1
echo $$$alias1

//to show compatibility with @
do [
echo $$@alias1
]
</code>

==Branching/Decisions==

Decisions are based on 6 key commands, '''if''', '''?''', '''cond''', '''case''' (integer), '''casef''' (float) and '''cases''' (string). There are also other ways to do this. For example you might be able to easily query something about an object, where it's obviously unique. You would then execute an alias whose name has this unique bit attached onto the end. This is an advanced method and is generally not recommended.

===if and ?===

Arguments: Cond True False

Unlike most other languages, cubescript's '''if''' contains an implicit else, in short we do not have an else statement. The provided condition is true if it ends up as a series of alpha numerics, or in the case of a number, as a value other than 0.

<code>
myalias1 = 5
myalias2 = "woot"

//if else-if else
if $myalias1 [
echo "myalias1 is true"
] [
//this shows the alpha numerics case
if $myalias2 [
echo "myalias1 is false and myalias2 is true"
] [
echo "myalias1 is false and myalias2 is false"
]
]
</code>

'''?''' acts exactly the same way, but there's one HUGE difference. '''?''' does not execute the chosen result.

<code>
//an example of where ? can be used where if would fail
items = 1
echo (format "You are carrying %1 item%2." $items (? (= $items 1) "" "s"))
</code>

===cond===

basically you provided a several pairs of arguments, the first half of the pair is the condition, and the second is the result. To put it in a programming perspective, this is like creating a long line of if else's together. Execution stops when the first condition is matched. Should you place several conditions where more than one may be true at any one time, only the first will be executed.

The following example assumes you have a light entity selected

<code>
lightstrength = [
cond [< (ea 0) 0] [
echo "It's like a black hole!"
] [= (ea 0) 0] [
echo "Blindlier than science!"
] [< (ea 0) 8] [
echo "It's weaker than Billy's night light!"
] [< (ea 0) 32] [
echo "Nice night light you got there"
] [< (ea 0) 96] [
echo "It's like a lamp, but it's not a lamp"
] [< (ea 0) 512] [
echo "By Jove! I can actually see the ground!"
] [>= (ea 0) 512] [
echo "Dark places are icky, don't you agree?"
]
]
</code>

===case===

This works similar to switches in most programming languages. The biggest difference is that you can't break out, nor evaluate multiple cases (aka, fallthroughs).

The first argument tells it which variable to use. The following arguments are given in pairs, the first half is the state, the second is the result.
If the state is a null type, it is considered the default case. The easiest way to generate a null type is to use ()

The following example requires a particles entity to be selected, it will print out what type it is. Do note that this example exceeds the 25 word limit.

<code>
parttype = [
pname = ""

case (ea 0) 0 [
pname = "Fire and Smoke"
] 1 [
pname = "Fire"
] 2 [
pname = "Smoke Plume"
] 3 [
pname = "Smoke"
] 4 [
pname = "Fountain"
] 5 [
pname = "Explosion"
] 6 [
pname = "Meter"
] 7 [
pname = "Vs Meter"
] 8 [
pname = "Text"
] 9 [
pname = "Flare"
] 10 [
pname = "Lightning"
] 11 [
pname = "Fire"
] 12 [
pname = "Smoke"
] 13 [
pname = "Water"
] 14 [
pname = "Snow"
] 15 [
pname = "Leaves"
] 32 [
pname = "Lens Flare"
] 33 [
pname = "Fixed Size Lens Flare"
] 34 [
pname = "Sparkly Lens Flare"
] 35 [
pname = "Sparkly Fixed Size Lens Flare"
] () [ //default
pname = "A very pretty albeit unsupported particle"
]

echo The particle you have selected is of type: $pname
]
</code>

===Naming===

another way of doing decisions/branches is to use paths with different names. This has limited usage though. in short it requires you to query some information to concatenate onto another word, which you would then execute. There are exceptions. Other than the number of results you can query, there is no limit here. A handy trick is to have several results execute the same alias, though this requires that they differ only slightly at most in operation.

<code>
//This example demonstrates the exception
//it requires you to have an entity selected
//This will conflict with showquickgui
newgui "particles" [guitext "It's like a random series of nothing"]
newgui "light" [guitext "SHINY!!!!"]
newgui "jumppad" [guitext "boing!"]

identify = [showgui (et)]
</code>

<code>
//shows a more standard example, at present this is exclusively used by edithud (see stdedit.cfg)
//this also requires you to have an entity selected.
identlight = [echo "it's so bright..."]
identdynlight = [identlight] // to demonstrate how different results can execute the same script
identjumppad = [echo "boing? boing!"]
identparticles = [echo "Please don't change it to a lens flare!"]

identify = [ if (enthavesel) [ident@(et)] [echo Select an entity first!]]
</code>

==Lists==

Ordered lists are the closest cubescript has to the likes of arrays. Their declaration is identical to any alias, as they are simply items in a string separated by white space. Using [] is recommended as the container of choice, since it allows you to use "" to include multi-word items in a list as a single unit as well as define the list over multiple lines. "" can also be used to define lists. An example can be inspected below.

<code>
//declares 2 equivalent lists of 3 elements
mylist1 = [one two "three four"]
mylist2 = "one two ^"three four^""

//prints the 3rd element
echo (at $mylist 2)
</code>

'''loops'''

There are at least 2 ways to loop through a list. The first method involves the use of looplist to iterate over it and the second the use of listlen to determine the list's length. The difference between using looplist and listlen is that you will not have a reliable way of determining an element's index and won't have to manually fetch the element from the list. Basically looplist is faster at the cost of some information and should be used in all cases where the index does not need to be known.
An example can be inspected below.

<code>
mylist = [
0
1
3.14159265359
2.71828182845
sqrt(-1)
1 //to demonstrate that the index cannot be determined reliably with looplist
]

//demonstrates looplist
looplist var $mylist [
echo number (listfind item $mylist [strcmp $var $item]) : $var
]

//demonstrates a loop + listlen combo
loop i (listlen $mylist) [
echo number $i : (at $mylist $i)
]
</code>

'''concatenation'''

Concatenation is pretty simple, albeit not very efficient. It is basically, setting the list to itself plus the additional item. This is of course best achieved through the concat commands.

<code>
mylist = [1 2 3 4 5 6 7 8 9 10]

//using concatword
mylist = (concatword $mylist " " 11)

//using format
mylist = (format "%1 %2" $mylist 12)

//using concat - we're also preparing it for pretty list
mylist = (concat $mylist 14)

//pretty list does add an item onto the list, but it changes the format dramatically and the new item is placed before the end
//it is ideal more so for making things pretty for presentation than concatenation
mylist = (prettylist $mylist 13)

//should print 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13 14
echo mylist is $mylist
</code>

concat returns everything given to it as a singular item, spaces and all. Concatword ignores spaces and ""'s must be explicitly provided. Concat is therefor ideal to add lists together.

<code>
mylist1 = [1 2 3 4 5]
mylist2 = [6 7 8 9 10]
mylist3 = [11 12 13 14 15]
mylist4 = [16 17 18 19 20]
mylist5 = [21 22 23 24 25]
mylist6 = [26 27 28 29 30]
finallist = ""

//how concatword merged three lists
finallist = (concatword $mylist1 " " $mylist2 " " $mylist3)

//concat unlike the above does not require
finallist = (concat $finallist $mylist4 $mylist5 $mylist6)

echo (prettylist $finallist)
</code>

'''finding'''

there are two ways to find things, the first is to use listfind, and the second is to loop through the list. Both are demonstrated in the example below

<code>
mylist = [
"Jack"
"Jane"
"Joseph"
]

//This is an example of looking for a single element, note that this variant of...
//strcmp unlike its C counterpart returns 1 when strings are equal
//in this example, a 0 should be printed at the top of your screen - listfind returns the index
echo (listfind f $mylist [strcmp $f "Jack"])

//In this example, -1, as Jill is not in the list
echo (listfind f $mylist [strcmp $f "Jill"])

//in this example, we want to find anything which contains an e and add it into a list
results = ""
looplist var $mylist [
if (>= (strstr $var "e") 0) [
results = (concatword $results "^"" $var " ^"")
]
]

//this should print: Jane Joseph
echo $results
</code>

=List of commands=

==General==

The following commands are quite often used in a lot of scripts.

* alias N B
** creates an alias named N with body B, the intext version is denoted as N = B (equivalent to alias N B)
* at S I
** returns the Ith element in string S, note that counting starts from 0. If it's out of range, "" is returned
* getalias A
** returns the value of A. this also does not produce a warning should an alias be undeclared, nor complains when fetching built in variables.
* if C T F (F is optional)
** if condition C is true, execute T, otherwise F is executed
* listlen S
** returns the amount of elements in list S
* loop V N B
** loops N times, and aliases the current iteration to V; B is executed every iteration.
* result S
** returns the string, useful when aliases need to be executed
* rnd N L
** chooses a random number between 0 and N-1 (inclusive). L sets the lower limit. eg rnd 12 7 will return either 7 8 9 10 or 11
* sleep N B
** executes B after a delay of N milliseconds. NOTE: even if N is <= 0, it'll still wait till the next frame before executing it
* while C B
** executed B while C is true. NOTE: surround C in a [] container, or you risk an infinite loop due to the condition not being reevaluated.

==Map Configuration==
'''''ONLY APPLIES TO FPSGAME'''''

The following commands are useful in level only aliases

*triggerstate
*level_trigger
**level trigger is invoked as level_trigger_1 = [] as an example, the end number is the 4th number in the mapmodel's strings
*level_base
**Used to give bases names in capture mode. This is unfortunately unused in PAS

==Binds==

The following commands are useful in binds.

*onrelease

==Gui Creation==

For newui, please see [[new menu editing]]

These commands are used to create various menus.

* cleargui
* guibar
* guibutton
* guicheckbox
* guifield
* guikeyfield
* guiimage
* guilist
* guirolloveraction
* guirollovername
* guislider
* guilistslider
* guinameslider
* guistayopen
* guitab
* guitext
* guititle
* guistrut
* newgui

==Comparisons==

The functions here can change the values, or return a logical comparison
for all intents and purposes, the C version of booleans apply here; values not equal to 0 are true - and functions that return true return 1

===Integer Arithmetic===

* + A B
** returns the value of the numbers added together
* <nowiki>*</nowiki> A B
** returns the result of multiplying A and B
* - A B
** returns the value of A - B
* = A B
** returns true of the two are equal
* != A B
** returns true if the two aren't equal
* <nowiki><</nowiki> A B
** returns true if A is less-than B
* <nowiki>></nowiki> A B
** returns true if A is greater-than B
* <nowiki><=</nowiki> A B
** returns true if A is less-than-or-equal-to B
* <nowiki>>=</nowiki> A B
** returns true if A is greater-than-or-equal-to B
* ! A
** if the argument is false, it returns true
* &&
** returns true if all arguments are true
* ||
** returns true it at least one argument is true
* div A B
** returns the value of A divided by B
* mod A B
** returns the modulus of the two arguments
* min
** returns the lowest valued argument of all provided arguments
* max
** returns the highest valued argument of all provided arguments

===Bitwise Integer Operations===

* ^ A B
** returns the value of A xor B ie (^ 8 4) is 12 - (^ 12 4) is 8
* & A B
** returns the value of the bits both A and B have
* | A B
** returns the value of the bits either A or B have
* ~ A
** returns the inverted bitwise version of A ie (& (~ 128) 255) is 127
* ^~ A B
** xor;s the arguments after applying an inversion on B
* &~ A B
** and's the arguments after applying an inversion on B
* |~ A B
** or's the arguments after applying an inversion on B
* <nowiki><<</nowiki> A N
** shifts A N bits
* <nowiki>>></nowiki> A N
** shifts A -N bits

===Floating Point Arithmetic===

Generally these just have an -f suffix

* +f A B
** returns the value of the numbers added together
* <nowiki>*f</nowiki> A B
** returns the result of multiplying A and B
* -f A B
** returns the value of A - B
* =f A B
** returns true of the two are equal
* !=f A B
** returns true if the two aren't equal
* <nowiki><f</nowiki> A B
** returns true if A is less-than B
* <nowiki>>f</nowiki> A B
** returns true if A is greater-than B
* <nowiki><=f</nowiki> A B
** returns true if A is less-than-or-equal-to B
* <nowiki>>=f</nowiki> A B
** returns true if A is greater-than-or-equal-to B
* divf A B
** returns the value of A divided by B
* modf A B
** returns the modulus of the two arguments
* minf
** returns the lowest valued argument of all provided arguments
* maxf
** returns the highest valued argument of all provided arguments

===Strings===

* =s A B
** returns 1 if the string matches, 0 otherwise
* !=s A B
** returns 0 if the string matches, 1 otherwise
* <nowiki><s</nowiki> A B
** returns true if the C strcmp returns less-than 0
* <nowiki>>s</nowiki> A B
** returns true if the C strcmp returns greater-than 0
* <nowiki><=s</nowiki> A B
** returns true if the C strcmp returns less-than-or-equal-to 0
* <nowiki>>=s</nowiki> A B
** returns true if the C strcmp returns greater-than-or-equal-to 0
* strcmp A B
** returns 1 if the string matches, 0 otherwise (unlike the C version with returns the disparity)
* strstr H N
** returns the position of N in H - otherwise -1 is returned
* strlen S
** returns the length of the string
* strreplace S O N
** replaces all instances of O inside string S with N

==String/text formatting==

These commands are used to format aliases which are normally huge bits of text

* concat C
** everything you type after will be returned; with expressions and substitutions performed
* concatword C
** the next 25 arguments will be executed and subsequently concatenated without any spaces between them
* format F S1 S2 S3 S4 S5 S6 S7 S8 S9
** F is a string containing %# tokens, format substitutes the arguments with their respective %# tokens (ie: S5 will replace %5)

=See Also=

*[[map_config|Map Configuration]]

[http://cvresumewritingservices.org/ resume writing services]