Computing and Software Wiki - User contributions [en]

BitTorrent

2008-04-14T03:31:19Z

Leunga5:

'''BitTorrent''' is a peer to peer file sharing protocol. The protocol works in a way such that there is not a single host distributing the file, instead, all users downloading the file also share in uploading as well. This reduces the burden on resources by the distributer as all users wishing to download the content are taking part in uploading pieces and parts of the data file.

__TOC__
==How It Works==
The method allows essentially any kind of data to be distributed in a manor such that all users downloading the same file, referred as leechers, will upload bits and parts of the file that they have already downloaded. Users that have the complete file and still connected to the tracker are referred as seeders. The tracker is simply a list of all users that are currently connected to the torrent of interest, while categorizing the number of leechers and seeders to determine the healthiness of the torrent.

Users download "torrent" files that are created specifically for the file to be distributed. Using a bittorrent client, the user opens the torrent file which contains the URL of the tracker that the torrent was published to, and attempts to connect to the tracker. If the tracker is up and running, the user enters the ''swarm'' which is the collection of all the seeders and leechers. The client makes many peer to peer TCP connections to trade the fragments of the file. Essentially, having lots of users with the file of interest being downloaded, the transfer speeds are maximized by sharing bits and parts of the files that has already been downloaded [1].

In general, most bittorrent clients have their own policies that determine how fast or slow a download achieves. Some clients require that the ratio of downloads and uploads be fairly even in order to achieve the fastest downloads, a policy of fairness. Other clients may attempt to exploit the generosity of the seeders and allow leechers to download at full speeds without having to contribute in uploading.

==Creating a Torrent==
Most bittorrent clients support creating your own torrent files. The setup wizards will ask for certain details such as the announcing tracker and the file you wish to distribute.

The file being created gets fragmented into many small pieces of equally sized data from 64kB to 4MB. A checksum is created for each of the fragmented pieces and stored in the torrent file with a hashing algorithm. When a complete fragment is downloaded by a user, the checksum is compared with the checksum in the torrent file for integrity. If the file is corrupt, the data will be re-downloaded [2].

Upon completion of creating a torrent, it is normally then hosted on many torrent search engines that have trackers for each of the torrents. Users would search for the file of interest, download the torrent and proceed in the process of downloading the file.

==Drawbacks and Issues==

BitTorrent relies heavily on the cooperativeness of the users involved in sharing the files. It is highly necessary for users that finish downloading to stay connected to the tracker for as long as possible to allow better distribution of complete and rare pieces of the file. However, greediness of users lead to dying trackers as they disconnect from the tracker as soon as they finish the downloading the file. This in turn reduces the number of seeders and fewer complete files to be distributed. In the worst case that there are no seeders left and all the leechers downloading are missing a rare part of the file, all the users remaining in the swarm will never complete the file. Therefore it is essential that there is cooperation between the users to give as well as take.

BitTorrent is in no way anonymous as all past and present users connected to the tracker can have their IP addresses obtained [2].
[[Image:bittorrent.jpg|thumb|600px|In this image is an example of the Azureus client on a Windows machine. It features the ability to have simultaneous downloads and uploads. The image shows information about the file being downloaded including the total file size, current size downloaded, number of seeders and leechers ( connected to and part of the swarm) as well as the users upload/download speed]]

==Industries Using BitTorrent==
Gaming industries such as the popular Massively Multiplayer Online Roleplaying Game, World of Warcraft by Blizzard Entertainment, has been using this technology since 2004 to provide game updates to the large user base.

Videos from Hollywood studios has licenses that have been allowed for redistribution using BitTorrent Inc. at their companies websites as well [2].

Many Open Source Software distributors are avid supporters of the technology in sharing their software for download.

==Popular Clients and Search Engines==
'''Clients'''
* [http://www.bittorrent.com/ BitTorrent Client] is the first original client
* [http://azureus.sourceforge.net/ Azureus BitTorrent Client] is a Java based client for cross-platform compatibility
* [http://utorrent.com/ µTorrent] is a light-weight, feature filled and easy to use client

'''Search Engines'''

Note: P2P is legal, however many of the torrents infringe on copyright laws and are infact illegal. However in Canada, users are protected from P2P copyright lawsuits. [3]

* [http://isohunt.com/ ISOhunt] The top most popular torrent database
* [http://mininova.org/ Mininova] Successor to Supernova, one of the top search engines
* [http://thepiratebay.org/ The Pirate Bay] Single largest torrent database

==See Also==
[[Peer To Peer Network Security]]

==References==
[1] Howstuffworks - [http://computer.howstuffworks.com/bittorrent.htm How Bittorrent Works] Carmack, C

[2] Wikipedia - [http://en.wikipedia.org/wiki/BitTorrent_%28protocol%29 BitTorrent]

[3] About.com - [http://netforbeginners.about.com/od/peersharing/f/torrentsearch.htm What are the Best Bit Torrent Search Engines?]

--[[User:Leunga5|Leunga5]] 18:35, 13 April 2008 (EDT)

BitTorrent

2008-04-14T03:23:24Z

Leunga5:

'''BitTorrent''' is a peer to peer file sharing protocol. The protocol works in a way such that there is not a single host distributing the file, instead, all users downloading the file also share in uploading as well. This reduces the burden on resources by the distributer as all users wishing to download the content are taking part in uploading pieces and parts of the data file.

__TOC__
==How It Works==
The method allows essentially any kind of data to be distributed in a manor such that all users downloading the same file, referred as leechers, will upload bits and parts of the file that they have already downloaded. Users that have the complete file and still connected to the tracker are referred as seeders. The tracker is simply a list of all users that are currently connected to the torrent of interest, while categorizing the number of leechers and seeders to determine the healthiness of the torrent.

Users download "torrent" files that are created specifically for the file to be distributed. Using a bittorrent client, the user opens the torrent file which contains the URL of the tracker that the torrent was published to, and attempts to connect to the tracker. If the tracker is up and running, the user enters the ''swarm'' which is the collection of all the seeders and leechers. The client makes many peer to peer TCP connections to trade the fragments of the file. Essentially, having lots of users with the file of interest being downloaded, the transfer speeds are maximized by sharing bits and parts of the files that has already been downloaded [1].

In general, most bittorrent clients have their own policies that determine how fast or slow a download achieves. Some clients require that the ratio of downloads and uploads be fairly even in order to achieve the fastest downloads, a policy of fairness. Other clients may attempt to exploit the generosity of the seeders and allow leechers to download at full speeds without having to contribute in uploading.

==Creating a Torrent==
Most bittorrent clients support creating your own torrent files. The setup wizards will ask for certain details such as the announcing tracker and the file you wish to distribute.

The file being created gets fragmented into many small pieces of equally sized data from 64kB to 4MB. A checksum is created for each of the fragmented pieces and stored in the torrent file with a hashing algorithm. When a complete fragment is downloaded by a user, the checksum is compared with the checksum in the torrent file for integrity. If the file is corrupt, the data will be re-downloaded [2].

Upon completion of creating a torrent, it is normally then hosted on many torrent search engines that have trackers for each of the torrents. Users would search for the file of interest, download the torrent and proceed in the process of downloading the file.

==Drawbacks and Issues==

BitTorrent relies heavily on the cooperativeness of the users involved in sharing the files. It is highly necessary for users that finish downloading to stay connected to the tracker for as long as possible to allow better distribution of complete and rare pieces of the file. However, greediness of users lead to dying trackers as they disconnect from the tracker as soon as they finish the downloading the file. This in turn reduces the number of seeders and fewer complete files to be distributed. In the worst case that there are no seeders left and all the leechers downloading are missing a rare part of the file, all the users remaining in the swarm will never complete the file. Therefore it is essential that there is cooperation between the users to give as well as take.

BitTorrent is in no way anonymous as all past and present users connected to the tracker can have their IP addresses obtained [2].
[[Image:bittorrent.jpg|thumb|600px|In this image is an example of the Azureus client on a Windows machine. It features the ability to have simultaneous downloads and uploads. The image shows information about the file being downloaded including the total file size, current size downloaded, number of seeders and leechers ( connected to and part of the swarm) as well as the users upload/download speed]]

==Popular Clients and Search Engines==
'''Clients'''
* [http://www.bittorrent.com/ BitTorrent Client] is the first original client
* [http://azureus.sourceforge.net/ Azureus BitTorrent Client] is a Java based client for cross-platform compatibility
* [http://utorrent.com/ µTorrent] is a light-weight, feature filled and easy to use client

'''Search Engines'''
Note: P2P is legal, however many of the torrents infringe on copyright laws and are infact illegal. However in Canada, users are protected from P2P copyright lawsuits. [3]
* [http://isohunt.com/ ISOhunt] The top most popular torrent database
* [http://mininova.org/ Mininova] Successor to Supernova, one of the top search engines
* [http://thepiratebay.org/ The Pirate Bay] Single largest torrent database

==See Also==
[[Peer To Peer Network Security]]

==References==
[1] Howstuffworks - [http://computer.howstuffworks.com/bittorrent.htm How Bittorrent Works] Carmack, C

[2] Wikipedia - [http://en.wikipedia.org/wiki/BitTorrent_%28protocol%29 BitTorrent]

[3] About.com - [http://netforbeginners.about.com/od/peersharing/f/torrentsearch.htm What are the Best Bit Torrent Search Engines?]

--[[User:Leunga5|Leunga5]] 18:35, 13 April 2008 (EDT)

BitTorrent

2008-04-14T01:56:24Z

Leunga5:

'''BitTorrent''' is a peer to peer file sharing protocol. The protocol works in a way such that there is not a single host distributing the file, instead, all users downloading the file also share in uploading as well. This reduces the burden on resources by the distributer as all users wishing to download the content are taking part in uploading pieces and parts of the data file.

__TOC__
==How It Works==
The method allows essentially any kind of data to be distributed in a manor such that all users downloading the same file, referred as leechers, will upload bits and parts of the file that they have already downloaded. Users that have the complete file and still connected to the tracker are referred as seeders. The tracker is simply a list of all users that are currently connected to the torrent of interest, while categorizing the number of leechers and seeders to determine the healthiness of the torrent.

Users download "torrent" files that are created specifically for the file to be distributed. Using a bittorrent client, the user opens the torrent file which contains the URL of the tracker that the torrent was published to, and attempts to connect to the tracker. If the tracker is up and running, the user enters the ''swarm'' which is the collection of all the seeders and leechers. The client makes many peer to peer TCP connections to trade the fragments of the file. Essentially, having lots of users with the file of interest being downloaded, the transfer speeds are maximized by sharing bits and parts of the files that has already been downloaded [1].

In general, most bittorrent clients have their own policies that determine how fast or slow a download achieves. Some clients require that the ratio of downloads and uploads be fairly even in order to achieve the fastest downloads, a policy of fairness. Other clients may attempt to exploit the generosity of the seeders and allow leechers to download at full speeds without having to contribute in uploading.

==Creating a Torrent==
Most bittorrent clients support creating your own torrent files. The setup wizards will ask for certain details such as the announcing tracker and the file you wish to distribute.

The file being created gets fragmented into many small pieces of equally sized data from 64kB to 4MB. A checksum is created for each of the fragmented pieces and stored in the torrent file with a hashing algorithm. When a complete fragment is downloaded by a user, the checksum is compared with the checksum in the torrent file for integrity. If the file is corrupt, the data will be re-downloaded [2].

Upon completion of creating a torrent, it is normally then hosted on many torrent search engines that have trackers for each of the torrents. Users would search for the file of interest, download the torrent and proceed in the process of downloading the file.

==Drawbacks and Issues==

BitTorrent relies heavily on the cooperativeness of the users involved in sharing the files. It is highly necessary for users that finish downloading to stay connected to the tracker for as long as possible to allow better distribution of complete and rare pieces of the file. However, greediness of users lead to dying trackers as they disconnect from the tracker as soon as they finish the downloading the file. This in turn reduces the number of seeders and fewer complete files to be distributed. In the worst case that there are no seeders left and all the leechers downloading are missing a rare part of the file, all the users remaining in the swarm will never complete the file. Therefore it is essential that there is cooperation between the users to give as well as take.

BitTorrent is in no way anonymous as all past and present users connected to the tracker can have their IP addresses obtained [2].
[[Image:bittorrent.jpg|thumb|600px|In this image is an example of the Azureus client on a Windows machine. It features the ability to have simultaneous downloads and uploads. The image shows information about the file being downloaded including the total file size, current size downloaded, number of seeders and leechers ( connected to and part of the swarm) as well as the users upload/download speed]]

==Popular Clients and Search Engines==
'''Clients'''
* [http://www.bittorrent.com/ BitTorrent Client] is the first original client
* [http://azureus.sourceforge.net/ Azureus BitTorrent Client] is a Java based client for cross-platform compatibility
* [http://utorrent.com/ µTorrent] is a light-weight, feature filled and easy to use client

'''Search Engines'''
Most search engines

==See Also==
[[Peer To Peer Network Security]]

==References==
[1] Howstuffworks - [http://computer.howstuffworks.com/bittorrent.htm How Bittorrent Works] Carmack, C

[2] Wikipedia - [http://en.wikipedia.org/wiki/BitTorrent_%28protocol%29 BitTorrent]

--[[User:Leunga5|Leunga5]] 18:35, 13 April 2008 (EDT)

File:Bittorrent.jpg

2008-04-14T01:44:46Z

Leunga5: Image of Azureus bittorrent client

Image of Azureus bittorrent client

BitTorrent

2008-04-13T22:44:12Z

Leunga5:

'''BitTorrent''' is a peer to peer file sharing protocol. The protocol works in a way such that there is not a single host distributing the file, instead, all users downloading the file also share in uploading as well. This reduces the burden on resources by the distributer as all users wishing to download the content are taking part in uploading pieces and parts of the data file.

__TOC__
==How It Works==
The method allows essentially any kind of data to be distributed in a manor such that all users downloading the same file, referred as leechers, will upload bits and parts of the file that they have already downloaded. Users that have the complete file and still connected to the tracker are referred as seeders. The tracker is simply a list of all users that are currently connected to the torrent of interest, while categorizing the number of leechers and seeders to determine the healthiness of the torrent.

Users download "torrent" files that are created specifically for the file to be distributed. Using a bittorrent client, the user opens the torrent file which contains the URL of the tracker that the torrent was published to, and attempts to connect to the tracker. If the tracker is up and running, the user enters the ''swarm'' which is the collection of all the seeders and leechers. The client makes many peer to peer TCP connections to trade the fragments of the file. Essentially, having lots of users with the file of interest being downloaded, the transfer speeds are maximized by sharing bits and parts of the files that has already been downloaded [1].

In general, most bittorrent clients have their own policies that determine how fast or slow a download achieves. Some clients require that the ratio of downloads and uploads be fairly even in order to achieve the fastest downloads, a policy of fairness. Other clients may attempt to exploit the generosity of the seeders and allow leechers to download at full speeds without having to contribute in uploading.

==Creating a Torrent==
Most bittorrent clients support creating your own torrent files. The setup wizards will ask for certain details such as the announcing tracker and the file you wish to distribute.

The file being created gets fragmented into many small pieces of equally sized data from 64kB to 4MB. A checksum is created for each of the fragmented pieces and stored in the torrent file with a hashing algorithm. When a complete fragment is downloaded by a user, the checksum is compared with the checksum in the torrent file for integrity. If the file is corrupt, the data will be re-downloaded [2].

Upon completion of creating a torrent, it is normally then hosted on many torrent search engines that have trackers for each of the torrents. Users would search for the file of interest, download the torrent and proceed in the process of downloading the file.

==Drawbacks and Issues==

BitTorrent relies heavily on the cooperativeness of the users involved in sharing the files. It is highly necessary for users that finish downloading to stay connected to the tracker for as long as possible to allow better distribution of complete and rare pieces of the file. However, greediness of users lead to dying trackers as they disconnect from the tracker as soon as they finish the downloading the file. This in turn reduces the number of seeders and fewer complete files to be distributed. In the worst case that there are no seeders left and all the leechers downloading are missing a rare part of the file, all the users remaining in the swarm will never complete the file. Therefore it is essential that there is cooperation between the users to give as well as take.

BitTorrent is in no way anonymous as all past and present users connected to the tracker can have their IP addresses obtained [2].

==Popular Clients and Search Engines==
'''Clients'''
* [http://www.bittorrent.com/ BitTorrent Client]
* [http://azureous.sourceforge.net/ Azureus Java BitTorrent Client]
* [http://utorrent.com/ µTorrent]

==See Also==
[[Peer To Peer Network Security]]

==References==
[1] Howstuffworks - [http://computer.howstuffworks.com/bittorrent.htm How Bittorrent Works] Carmack, C

[2] Wikipedia - [http://en.wikipedia.org/wiki/BitTorrent_%28protocol%29 BitTorrent]

--[[User:Leunga5|Leunga5]] 18:35, 13 April 2008 (EDT)

BitTorrent

2008-04-13T22:35:39Z

Leunga5:

'''BitTorrent''' is a peer to peer file sharing protocol. The protocol works in a way such that there is not a single host distributing the file, instead, all users downloading the file also share in uploading as well. This reduces the burden on resources by the distributer as all users wishing to download the content are taking part in uploading pieces and parts of the data file.

__TOC__
==How It Works==
The method allows essentially any kind of data to be distributed in a manor such that all users downloading the same file, referred as leechers, will upload bits and parts of the file that they have already downloaded. Users that have the complete file and still connected to the tracker are referred as seeders. The tracker is simply a list of all users that are currently connected to the torrent of interest, while categorizing the number of leechers and seeders to determine the healthiness of the torrent.

Users download "torrent" files that are created specifically for the file to be distributed. Using a bittorrent client, the user opens the torrent file which contains the URL of the tracker that the torrent was published to, and attempts to connect to the tracker. If the tracker is up and running, the user enters the ''swarm'' which is the collection of all the seeders and leechers. The client makes many peer to peer TCP connections to trade the fragments of the file. Essentially, having lots of users with the file of interest being downloaded, the transfer speeds are maximized by sharing bits and parts of the files that has already been downloaded [1].

In general, most bittorrent clients have their own policies that determine how fast or slow a download achieves. Some clients require that the ratio of downloads and uploads be fairly even in order to achieve the fastest downloads, a policy of fairness. Other clients may attempt to exploit the generosity of the seeders and allow leechers to download at full speeds without having to contribute in uploading.

==Creating a Torrent==
Most bittorrent clients support creating your own torrent files. The setup wizards will ask for certain details such as the announcing tracker and the file you wish to distribute.

The file being created gets fragmented into many small pieces of equally sized data from 64kB to 4MB. A checksum is created for each of the fragmented pieces and stored in the torrent file with a hashing algorithm. When a complete fragment is downloaded by a user, the checksum is compared with the checksum in the torrent file for integrity. If the file is corrupt, the data will be re-downloaded [2].

Upon completion of creating a torrent, it is normally then hosted on many torrent search engines that have trackers for each of the torrents. Users would search for the file of interest, download the torrent and proceed in the process of downloading the file.

==Drawbacks and Issues==

BitTorrent relies heavily on the cooperativeness of the users involved in sharing the files. It is highly necessary for users that finish downloading to stay connected to the tracker for as long as possible to allow better distribution of complete and rare pieces of the file. However, greediness of users lead to dying trackers as they disconnect from the tracker as soon as they finish the downloading the file. This in turn reduces the number of seeders and fewer complete files to be distributed. In the worst case that there are no seeders left and all the leechers downloading are missing a rare part of the file, all the users remaining in the swarm will never complete the file. Therefore it is essential that there is cooperation between the users to give as well as take.

BitTorrent is in no way anonymous as all past and present users connected to the tracker can have their IP addresses obtained [2].

==Popular Clients and Search Engines==
Clients

==See Also==
[[Peer To Peer Network Security]]

==References==
[1] Howstuffworks - [http://computer.howstuffworks.com/bittorrent.htm How Bittorrent Works] Carmack, C

[2] Wikipedia - [http://en.wikipedia.org/wiki/BitTorrent_%28protocol%29 BitTorrent]

--[[User:Leunga5|Leunga5]] 18:35, 13 April 2008 (EDT)

BitTorrent

2008-04-13T22:09:42Z

Leunga5:

BitTorrent

2008-04-13T22:09:01Z

Leunga5:

BitTorrent

2008-04-09T02:17:40Z

Leunga5:

BitTorrent

2008-04-09T02:01:48Z

Leunga5:

BitTorrent

2008-04-09T01:54:57Z

Leunga5: New page: '''BitTorrent''' is a peer to peer file sharing protocol. The protocol works in a way such that there is not a single host distributing the file, instead, all users downloading the file a...

Script Editor Introduction

2008-03-19T19:01:53Z

Leunga5: New page: The '''Script Editor''' is a tool provided by the C4 engine.

The '''Script Editor''' is a tool provided by the C4 engine.

Basic Usages

2008-03-19T18:59:18Z

Leunga5:

The script editor is a bundle of functionalities provided by the game engine as well as custom created ones for the psychologists disposal. In effect, a script acts as a series of methods in a tree of nodes. Each node is a method that has a functionality. The C4Engine Wiki contains a very useful entry that explains the basic commands of the Script Editor. As such, it has been copied and pasted here for quicker reference.

==Using the Script Editor==
[[Image:scriptedit.gif|right]]The C4 Engine has the capability to execute scripted actions in response to some kind of trigger. A script in C4 does not require the use of any programming language, but is instead organized into a tree of actions called ''methods'' that can be edited with a tool that displays a graphical representation of the script.

The image to the right shows the Script Editor. A script can be assigned to any node in a scene and edited by attaching the script controller to it as follows.

# In the World Editor, select the node to which you would like to assign a script.
# Choose Get Info from the Node menu or just press Ctrl-I.
# Click on the Controller tab in the Get Info dialog.
# Select the Script controller from the list of available controllers.
# Click on the Edit Script button that appears to open the Script Editor.
<br>

==Creating a New Script==

The first time the Script Editor is opened for a particular node, it shows a single method in the script called “Root”. This method performs no action and only serves as the root of the script's method tree. A new method is added to a script by dragging it from the palette on the left side of the editor to the method that precedes it. Any number of methods can be dragged to the same parent method in the script tree. The first method added to a script will always be dragged to the root method.

When a method is selected (which happens automatically to new methods as they are inserted into the tree), its settings are displayed on the right side of the editor. Each type of method has different settings that control how it is executed. Many methods perform some kind of operation on a ''target node'', and a popup menu labelled “Target node” appears when such a method is selected. The target node of the method may be any one of the following

* The target node of the script controller itself. This is the same node that the script is attached to.
* The trigger node that was activated and caused the script to execute.
* The node that activated the trigger node (the ''activator'' node).
* Any node that is connected to the target node of the controller.

(The trigger node or activator node may not exist. Any method that is executed for a nonexistant node behaves as a no-operation and completes immediately.)

==Editing a Script==

Once a method has been placed in the script tree, its settings can be changed by clicking on it. A method can be repositioned in the tree by selecting the Move tool at the bottom of the editor and using it to drag an existing method to a new parent method. When a method is moved, all of its descendants move with it. A method cannot be dragged to one of its descendants.

A method can be removed from the tree by selecting it and clicking the Delete Method button at the bottom of the editor. Pressing the Delete or Backspace key will also delete a selected method. When a method is deleted, its descendants are moved up to the parent of the deleted method. All of a method's descendants can be deleted by selecting the method and clicking the Delete Subtree button.

==Script Editor Tools==

There are four tool buttons at the bottom of the Script Editor window, and they have the following uses. In addition to clicking on the tool button, each of these tools can also be selected by pressing the shortcut number key as shown in the table. (The shortcuts were chosen to be the same as the corresponding tools in the World Editor.)

{| border="1" cellspacing="0" cellpadding="3" width="75%"
| bgcolor=#E0E0E0 | '''Icon'''
| bgcolor=#E0E0E0 | '''Shortcut'''
| bgcolor=#E0E0E0 | '''Function'''
|-
| [[Image:tool1.gif]]
| 1
| '''Select'''. Selects a method in a script.
|-
| [[Image:tool2.gif]]
| 2
| '''Move'''. Selects and moves methods around in a script.
|-
| [[Image:tool6.gif]]
| 6
| '''Pan'''. Pans the script tree viewport. Holding the Alt key (Option on the Mac) temporarily selects the pan tool.
|-
| [[Image:tool7.gif]]
| 7
| '''Zoom'''. Changes the scale of the script tree viewport. Using the mouse wheel with any other tool also zooms.
|}
<br>

==Script Execution==

When a script is executed, all of the immediate descendants of the root method are first executed, and these all run simultaneously. When a particular method completes its execution, which could be immediately or could be after some amount of time dependending on the operation being performed, all of its immediate descendants are then executed at the same time. This process continues until all of the methods in the script have executed, at which time the script goes back into a non-executing state.

==Standard Script Methods==

There are several types of script methods that are defined in the engine module. An application module can define any number of its own custom script methods as well, and they will show up in the palette on the left side of the script editor window.

The following table describes the operation of the standard methods.

{| border="1" cellspacing="0" cellpadding="3" width="75%"
| bgcolor=#E0E0E0 | '''Method'''
| bgcolor=#E0E0E0 | '''Description'''
|-
| Call Function
| This method calls a function of the controller attached to the method's target node. The specific settings depend on the purpose of the function itself. This method completes when the function indicates that is has finished what it's doing.
|-
| Change Settings
| This method changes one or more settings for the object attached to the target node and completes immediately.
|-
| Activate Controller
| This method activates the controller attached to the method's target node. The effect depends on the controller being activated. In the case that the target node has a script controller attached to it, the script is executed. This method always completes immediately without waiting for the activated controller to signal completion.
|-
| Enable Node
| This method enables its target node and completes immediately.
|-
| Disable Node
| This method disables its target node and completes immediately.
|-
| Delete Node
| This method deletes its target node and completes immediately. The node to which the script is attached, or any of its ancestors, cannot be deleted with this method.
|-
| Show Geometry
| This method shows its target node (if it's a geometry node) and completes immediately.
|-
| Hide Geometry
| This method hides its target node (if it's a geometry node) and completes immediately.
|-
| Delay
| This method simply waits for a specified amount of time before completing.
|-
| Play Ambient Sound
| This method plays a sound resource without 3D spatialization. The method completes when the sound has finished playing.
|-
| Play Sound Source
| This method plays its target node (if it's a source node). If the source was already playing or the source is looping, then the method completes immediately. Otherwise, the method completes when the source finishes playing.
|-
| Stop Sound Source
| This method stops its target node (if it's a source node) and completes immediately.
|-
| Change Material Color
| This method changes the color of one of the material attributes assigned to its target node (if it's a geometry node) and completes immediately. Since materials are shared, all geometry nodes using the same material, not necessarily just the target, are affected. Thus, to change a material color for only one geometry node, it should use a unique material. This method can change any material attribute that includes a color, such as diffuse, specular, or emission.
|-
| Sleep
| This method puts a controller to sleep.
|-
| Wake
| This method awakens a controller.
|}

Return to [[RCaragogo]]

==Reference==
[http://www.terathon.com/wiki/index.php?title=Using_the_Script_Editor C4Engine Wiki Using the Script Editor]

Basic Usages

2008-03-19T18:57:44Z

Leunga5:

The script editor is a bundle of functionalities provided by the game engine as well as custom created ones for the psychologists disposal. In effect, a script acts as a series of methods in a tree of nodes. Each node is a method that has a functionality. The C4Engine Wiki contains a very useful entry that explains the basic commands of the Script Editor. As such, it has been copied and pasted here for quicker reference.

==Using the Script Editor==
[[Image:scriptedit.gif|right]]The C4 Engine has the capability to execute scripted actions in response to some kind of trigger. A script in C4 does not require the use of any programming language, but is instead organized into a tree of actions called ''methods'' that can be edited with a tool that displays a graphical representation of the script.

The image to the right shows the Script Editor. A script can be assigned to any node in a scene and edited by attaching the script controller to it as follows.

# In the World Editor, select the node to which you would like to assign a script.
# Choose Get Info from the Node menu or just press Ctrl-I.
# Click on the Controller tab in the Get Info dialog.
# Select the Script controller from the list of available controllers.
# Click on the Edit Script button that appears to open the Script Editor.
<br>

==Creating a New Script==

The first time the Script Editor is opened for a particular node, it shows a single method in the script called “Root”. This method performs no action and only serves as the root of the script's method tree. A new method is added to a script by dragging it from the palette on the left side of the editor to the method that precedes it. Any number of methods can be dragged to the same parent method in the script tree. The first method added to a script will always be dragged to the root method.

When a method is selected (which happens automatically to new methods as they are inserted into the tree), its settings are displayed on the right side of the editor. Each type of method has different settings that control how it is executed. Many methods perform some kind of operation on a ''target node'', and a popup menu labelled “Target node” appears when such a method is selected. The target node of the method may be any one of the following

* The target node of the script controller itself. This is the same node that the script is attached to.
* The trigger node that was activated and caused the script to execute.
* The node that activated the trigger node (the ''activator'' node).
* Any node that is connected to the target node of the controller.

(The trigger node or activator node may not exist. Any method that is executed for a nonexistant node behaves as a no-operation and completes immediately.)

==Editing a Script==

Once a method has been placed in the script tree, its settings can be changed by clicking on it. A method can be repositioned in the tree by selecting the Move tool at the bottom of the editor and using it to drag an existing method to a new parent method. When a method is moved, all of its descendants move with it. A method cannot be dragged to one of its descendants.

A method can be removed from the tree by selecting it and clicking the Delete Method button at the bottom of the editor. Pressing the Delete or Backspace key will also delete a selected method. When a method is deleted, its descendants are moved up to the parent of the deleted method. All of a method's descendants can be deleted by selecting the method and clicking the Delete Subtree button.

==Script Editor Tools==

There are four tool buttons at the bottom of the Script Editor window, and they have the following uses. In addition to clicking on the tool button, each of these tools can also be selected by pressing the shortcut number key as shown in the table. (The shortcuts were chosen to be the same as the corresponding tools in the World Editor.)

{| border="1" cellspacing="0" cellpadding="3" width="75%"
| bgcolor=#E0E0E0 | '''Icon'''
| bgcolor=#E0E0E0 | '''Shortcut'''
| bgcolor=#E0E0E0 | '''Function'''
|-
| [[Image:tool1.gif]]
| 1
| '''Select'''. Selects a method in a script.
|-
| [[Image:tool2.gif]]
| 2
| '''Move'''. Selects and moves methods around in a script.
|-
| [[Image:tool6.gif]]
| 6
| '''Pan'''. Pans the script tree viewport. Holding the Alt key (Option on the Mac) temporarily selects the pan tool.
|-
| [[Image:tool7.gif]]
| 7
| '''Zoom'''. Changes the scale of the script tree viewport. Using the mouse wheel with any other tool also zooms.
|}
<br>

==Script Execution==

When a script is executed, all of the immediate descendants of the root method are first executed, and these all run simultaneously. When a particular method completes its execution, which could be immediately or could be after some amount of time dependending on the operation being performed, all of its immediate descendants are then executed at the same time. This process continues until all of the methods in the script have executed, at which time the script goes back into a non-executing state.

==Standard Script Methods==

There are several types of script methods that are defined in the engine module. An application module can define any number of its own custom script methods as well, and they will show up in the palette on the left side of the script editor window.

The following table describes the operation of the standard methods.

{| border="1" cellspacing="0" cellpadding="3" width="75%"
| bgcolor=#E0E0E0 | '''Method'''
| bgcolor=#E0E0E0 | '''Description'''
|-
| Call Function
| This method calls a function of the controller attached to the method's target node. The specific settings depend on the purpose of the function itself. This method completes when the function indicates that is has finished what it's doing.
|-
| Change Settings
| This method changes one or more settings for the object attached to the target node and completes immediately.
|-
| Activate Controller
| This method activates the controller attached to the method's target node. The effect depends on the controller being activated. In the case that the target node has a script controller attached to it, the script is executed. This method always completes immediately without waiting for the activated controller to signal completion.
|-
| Enable Node
| This method enables its target node and completes immediately.
|-
| Disable Node
| This method disables its target node and completes immediately.
|-
| Delete Node
| This method deletes its target node and completes immediately. The node to which the script is attached, or any of its ancestors, cannot be deleted with this method.
|-
| Show Geometry
| This method shows its target node (if it's a geometry node) and completes immediately.
|-
| Hide Geometry
| This method hides its target node (if it's a geometry node) and completes immediately.
|-
| Delay
| This method simply waits for a specified amount of time before completing.
|-
| Play Ambient Sound
| This method plays a sound resource without 3D spatialization. The method completes when the sound has finished playing.
|-
| Play Sound Source
| This method plays its target node (if it's a source node). If the source was already playing or the source is looping, then the method completes immediately. Otherwise, the method completes when the source finishes playing.
|-
| Stop Sound Source
| This method stops its target node (if it's a source node) and completes immediately.
|-
| Change Material Color
| This method changes the color of one of the material attributes assigned to its target node (if it's a geometry node) and completes immediately. Since materials are shared, all geometry nodes using the same material, not necessarily just the target, are affected. Thus, to change a material color for only one geometry node, it should use a unique material. This method can change any material attribute that includes a color, such as diffuse, specular, or emission.
|-
| Sleep
| This method puts a controller to sleep.
|-
| Wake
| This method awakens a controller.
|}

==Reference==
[http://www.terathon.com/wiki/index.php?title=Using_the_Script_Editor C4Engine Wiki Using the Script Editor]

File:Tool7.gif

2008-03-19T18:57:06Z

Leunga5:

File:Tool6.gif

2008-03-19T18:56:56Z

Leunga5:

File:Tool2.gif

2008-03-19T18:56:44Z

Leunga5:

File:Tool1.gif

2008-03-19T18:56:35Z

Leunga5:

File:Scriptedit.gif

2008-03-19T18:56:25Z

Leunga5:

Choosing a Car

2008-03-17T14:15:10Z

Leunga5:

When the game is loaded, pressing the Start New Game button will reveal The Choose Car menu. To choose a car simply click on one of the models and hit the NEXT button to arrive at the [[Choosing a Map]] menu. The car that is selected will be highlighted and that model will be loaded when the game loads. Clicking the BACK button will return the user to the main menu.

[[Image:ChooseCar.JPG]]

Return to [[RCaragogo]]

Choosing a Map

2008-03-17T14:14:53Z

Leunga5:

After choosing the proper car model the map menu will appear next. Here just click on the image that represents the desired map and hit the START button. Hitting the START button will load the selected car model and the chosen map. Hitting the BACK button will return the user to the [[Choosing a Car]] menu allowing the user to change the car model.

[[Image:ChooseMap.JPG]]

Return to [[RCaragogo]]

Choosing a Car

2008-03-17T14:12:47Z

Leunga5:

Insert Image

2008-03-17T14:09:02Z

Leunga5:

'''Insert Image''' is a script editing tool that allows the editor to basically "upload" a picture by importing it as a texture into the world editor (by following the tutorial found at [[Importing Textures]]). By placing the texture in the appropriate folder as indicated in the importing tutorial, the editor can place this picture anywhere on the head up display (bounded by the resolution of the display). Inserting an image has many options available to alter the positioning and sizing of the picture however he/she wants. '''Important note:''' there is a constraint of ''20'' unique pictures that can be displayed on the head up display. This should be a sufficient number to provide the editor to create the experiment that he/she desires. The editor also has the option to just move an existing image instead of creating a new one by using the [[Move Image]] tool, thus allowing reuse of an image.

The '''Insert Image''' has an interface that requires the following to initialize an image: A picture ID (0-19) that uniquely identifies the picture, the height and width of the picture (this can be adjusted to the liking of the editor and DOES NOT require it to be the same size as the imported texture, however, note that distortion of the original picture may occur when the sizes changes are not in the original ratios), and either an absolute position (x,y in pixels) referenced from the top left corner of the screen as (0,0) or choose a preset value (1-9) describing 1: Top Left, 2: Top Center, 3: Top Right, 4: Left Center, 5: Center, 6: Right Center, 7: Bottom Left, 8: Bottom Center, and 9: Bottom Right. This allows the advanced user to either specify an exact location for enhanced accuracy, or for pictures that do not require precise positioning to use just the preset locations for easier location computation.

For the advanced users, the calculation of the absolute position of the picture takes reference as the top left corner of the picture. For instance, if the position was chosen to be at (200,200), then the top left corner of the picture will be placed at (200,200). The maximum pixels that can viewed is determined by the resolution of the screen. By default, the resolution of the game is set at (1024x768) resulting in only pixels of the picture within that range will appear. The preset values will automatically center the picture at one of the preset locations and display the pictures with reasonable sizes. Pictures that are too large may overlap with other pictures that have been placed on the screen too close.

Return to [[RCaragogo]]

Display Text

2008-03-17T14:08:48Z

Leunga5:

'''DIsplay Text''' is a script editing tool used to allow the editor to display text feedback to the user. The figure following displays the interface to the script. It is simply a single setting that takes a string that will be displayed on the feedback textbox in the center of the screen. This can be used in ways such as to provide feedback from a user's actions, or giving instructions for the user.

Return to [[RCaragogo]]

Move Image

2008-03-17T14:08:27Z

Leunga5:

'''Move Image''' is a script editing tool used to allow the editor to move a specified already created image to a different location. The move function takes a picture ID (0-19) that identifies the picture, and either a new absolute position (x,y in pixels) referenced from the top left corner of the screen as (0,0) or choose a preset value (1-9) describing 1: Top Left, 2: Top Center, 3: Top Right, 4: Left Center, 5: Center, 6: Right Center, 7: Bottom Left, 8: Bottom Center, and 9: Bottom Right. This allows the advanced user to either specify an exact location for enhanced accuracy, or for pictures that do not require precise positioning to use just the preset locations for easier location computation.

For the advanced users, the calculation of the absolute position of the picture takes reference as the top left corner of the picture. For instance, if the position was chosen to be at (200,200), then the top left corner of the picture will be placed at (200,200). The maximum pixels that can viewed is determined by the resolution of the screen. By default, the resolution of the game is set at (1024x768) resulting in only pixels of the picture within that range will appear. The preset values will automatically center the picture at one of the preset locations and display the pictures with reasonable sizes. Pictures that are too large may overlap with other pictures that have been placed on the screen too close.

Note: At its current stage, it is not possible to edit the size of the image after its initialization in the [[Insert Image]] tool, however this option may be implemented at a later time.

Return to [[RCaragogo]]

Move Image

2008-03-17T14:07:50Z

Leunga5:

Insert Image

2008-03-17T14:07:22Z

Leunga5:

Move Image

2008-03-17T14:04:09Z

Leunga5:

'''Move Image''' is a script editing tool used to allow the editor to move a specified already created image to a different location. The move function takes a picture ID that identifies the picture, and either a new absolute position (x,y in pixels) referenced from the top left corner of the screen as (0,0) or choose a preset value (1-9) describing 1: Top Left, 2: Top Center, 3: Top Right, 4: Left Center, 5: Center, 6: Right Center, 7: Bottom Left, 8: Bottom Center, and 9: Bottom Right. This allows the advanced user to either specify an exact location for enhanced accuracy, or for pictures that do not require precise positioning to use just the preset locations for easier location computation.

For the advanced users, the calculation of the absolute position of the picture takes reference as the top left corner of the picture. For instance, if the position was chosen to be at (200,200), then the top left corner of the picture will be placed at (200,200). The maximum pixels that can viewed is determined by the resolution of the screen. By default, the resolution of the game is set at (1024x768) resulting in only pixels of the picture within that range will appear. The preset values will automatically center the picture at one of the preset locations and display the pictures with reasonable sizes. Pictures that are too large may overlap with other pictures that have been placed on the screen too close.

Note: At its current stage, it is not possible to edit the size of the image after its initialization in the [[Insert Image]] tool, however this option may be implemented at a later time.

Move Image

2008-03-17T14:03:46Z

Leunga5:

'''Move Image''' is a script editing tool used to allow the editor to move a specified already created image to a different location. The move function takes a picture ID that identifies the picture, and either a new absolute position (x,y in pixels) referenced from the top left corner of the screen as (0,0) or choose a preset value (1-9) describing 1: Top eft, 2: Top Center, 3: Top Right, 4: Left Center, 5: Center, 6: Right Center, 7: Bottom Left, 8: Bottom Center, and 9: Bottom Right. This allows the advanced user to either specify an exact location for enhanced accuracy, or for pictures that do not require precise positioning to use just the preset locations for easier location computation.

For the advanced users, the calculation of the absolute position of the picture takes reference as the top left corner of the picture. For instance, if the position was chosen to be at (200,200), then the top left corner of the picture will be placed at (200,200). The maximum pixels that can viewed is determined by the resolution of the screen. By default, the resolution of the game is set at (1024x768) resulting in only pixels of the picture within that range will appear. The preset values will automatically center the picture at one of the preset locations and display the pictures with reasonable sizes. Pictures that are too large may overlap with other pictures that have been placed on the screen too close.

Note: At its current stage, it is not possible to edit the size of the image after its initialization in the [[Insert Image]] tool, however this option may be implemented at a later time.

Insert Image

2008-03-17T13:58:48Z

Leunga5:

'''Insert Image''' is a script editing tool that allows the editor to basically "upload" a picture by importing it as a texture into the world editor (by following the tutorial found at [[Importing Textures]]). By placing the texture in the appropriate folder as indicated in the importing tutorial, the editor can place this picture any where on the head up display. Inserting an image has many options available to alter the positioning and sizing of the picture however he/she wants. '''Important note:''' there is a constraint of ''20'' unique pictures that can be displayed on the head up display. This should be a sufficient number to provide the editor to create the experiment that he/she desires. The editor also has the option to just move an existing image instead of creating a new one and that is explained in the [[Move Image]] tutorial, thus allowing reuse of an image.

The '''Insert Image''' has an interface that requires the following to initialize an image: A picture ID that uniquely identifies the picture, the height and width of the picture (this can be adjusted to the liking of the editor and DOES NOT require it to be the same size as the imported texture, however, note that distortion of the original picture may occur when the sizes changes are not in the original ratios), and either an absolute position (x,y in pixels) referenced from the top left corner of the screen as (0,0) or choose a preset value (1-9) describing 1: Top eft, 2: Top Center, 3: Top Right, 4: Left Center, 5: Center, 6: Right Center, 7: Bottom Left, 8: Bottom Center, and 9: Bottom Right. This allows the advanced user to either specify an exact location for enhanced accuracy, or for pictures that do not require precise positioning to use just the preset locations for easier location computation.

For the advanced users, the calculation of the absolute position of the picture takes reference as the top left corner of the picture. For instance, if the position was chosen to be at (200,200), then the top left corner of the picture will be placed at (200,200). The preset values will automatically center the picture at one of the preset locations.

Move Image

2008-03-17T13:51:17Z

Leunga5:

Move Image

2008-03-17T13:40:24Z

Leunga5: New page: '''Move Image''' is a script editing tool where the editor has the ability to move a specified image to a different location. The move function takes a picture ID that identifies the pict...

'''Move Image''' is a script editing tool where the editor has the ability to move a specified image to a different location. The move function takes a picture ID that identifies the picture

RCaragogo

2008-03-14T15:42:52Z

Leunga5:

RCar-A-Go-Go
SE 4GP6 Group 2 Capstone Project

----

How does this stuff work :S