OpenClonk Wiki - User contributions [en]

C4DT Editors

2012-04-10T23:46:30Z

Mortimer: Add section about Eclipse Auto-Refresh

==Introduction==
As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.
Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.
Eclipse provides different internal editors for different file types. For Clonk-specific files, C4DT adds some more to the list. Among those are a
*C4Script Editor
*Landscape.txt Editor
*Ini Files Editor (DefCore.txt, ActMap.txt etc)

All editors provided by C4DT offer suitable syntax highlighting. Apart from that they include special support for the types of files they were intended for:
*The C4Script Editor is supposed to help you write scripts more quickly by displaying errors and warnings contained in the script as soon as you save them and offering you a list of identifiers you can insert in specific places. It also tries to make writing properly formatted scripts easier by automatically inserting closing brackets and indenting. In addition to that it also strives to make navigation among and inside scripts easier by hyperlinking between them and providing an outline of the script.
*The Landscape.txt Editor is tailored for editing - surprise! - Landscape.txt files. Sadly, it doesn't offer a live preview on how the generated map would look like so it's probably a good idea to use Mape instead. There are plans to include similar functionality directly in Eclipse though.
*The Ini Files Editor also includes support for hyperlinks.
==Navigation==
Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
*[[File:Eclipse_Hyperlinks.png|right]] '''Hyperlinks''': All valid identifiers can be turned into links by pressing Ctrl/⌘ while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png|right]] Identifiers in ini editors can also be turned into hyperlinks.
 
*[[File:Clonk_OpenObject.png|right]] '''Open Object Dialog''': The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.
 
[[File:Eclipse_BackForward.png|right]] '''Going back and forward''': When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar. On a Mac, you can also install [http://marketplace.eclipse.org/content/eclipse-multi-touch Eclipse Multitouch] to navigate back and forth using gestures.
 
[[File:Eclipse_DeclarationsFilter.png|right]]
'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.
 

==Getting Content Assistance==
When you are editing a script you can invoke a list offering you identifiers to insert. This list is context-sensitive so it will display different options depending on whether the cursor is inside a function or not or whether you are invoking it after having written '->'. The short cut for the Content Assist list is Ctrl+Space but like any other short cut it can be changed in the preferences.
[[File:Eclipse_ContentAssist.png]] 

==Improvements compared to generic text editors==
The C4Script editor adds special behaviour for some situations. Those are:
*[[File:Eclipse_AutomaticBlock.png|right]] Automatic block: When typing '{' and then pressing Return a block will be created automatically and the caret will be placed inside the block indented by one tab. 
*[[File:Eclipse_AutomaticParmBrackets.png|right]] When you type '(' or '[' the corresponding closing bracket will be automatically inserted. In order to not interrupt your typing those inserted closing brackets will be overridden if you type them by hand subsequently. In this special situation, pressing tab will cause the caret to jump over the closing bracket. 
*[[File:Eclipse_ParmHint.png|right]]Parameter hints: As soon as you enter the brackets of a function call the parameters will be displayed above, not at all by chance similar to C4Scripter. The mechanism to find the right parameters to display is kind of smart and will also work when calling a function on an object using '->' as long as C4DT can deduce the object type of the expression left to '->'. 
*[[File:Eclipse_AutoFunction.png|right]] When you want to declare a new function you can type the name and then invoke Content Assistance (Ctrl+Space). A function block will be created for you.

==Outline==
[[File:Eclipse_Outline.png|right]] C4DT Editors fill the Outline view with an outline of the files being edited. The default Clonk perspective places the outline on the left below the Project Explorer.
The outline allows you to filter the list of declarations using a regular expression or wildcard.
 
The outline also shows types of variables and return types of functions, as inferred by the internal C4Script parser. Of course, since C4Script is relatively dynamic in its nature with eval and arbitrary attribute setting and the like, all those type inferences are without guarantee and might not reflect the true usage of the variable. A question mark following the type signals that the parser detected the possibility of the variable having just about any type so the weather forecast character is even more pronounced in that case.
Type guesses in the form of [x-y: <type>] represent cases where the expression is anticipated to have some array type where the range from x to y is of the given type. There could also be some additional '…' thrown in which would signify that the array will probably have more elements at runtime than those in the specified range.

==Errors & Warnings==
[[File:Eclipse_ProblemsView.png|right]] The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.
For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].
 
Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.
[[File:Eclipse_ProblemsFilter.png]]

==Quick Fixes==
[[File:Eclipse_QuickFix.png|right]]
For certain common cases of errors, c4dt offers automatic quick fixes which are offered to you when you press Ctrl/⌘+1 while having the cursor in a script inside a region marked as erroneous/problematic.

==Additional Views==
C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.
*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

==Auto-Refresh==
[[File:Eclipse_AutoRefresh.png|right]]
When updating your local repository clone, Eclipse tends to get confused because it keeps its own cache of file contents which won't match with the actual file contents after updating, so messages like 'This and that is out of sync with the file system' will pop up. To remedy that, you can open the General->Workspace preferences and set the settings as shown on the right.

File:Eclipse AutoRefresh.png

2012-04-10T23:44:31Z

Mortimer: Eclipse Auto-Refresh preferences

Eclipse Auto-Refresh preferences

C4DT Editors

2011-10-25T16:47:02Z

Mortimer: /* Outline */

C4DT Editors

2011-10-16T20:05:15Z

Mortimer: Move Quick Fixes up

==Introduction==
As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.
Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.
Eclipse provides different internal editors for different file types. For Clonk-specific files, C4DT adds some more to the list. Among those are a
*C4Script Editor
*Landscape.txt Editor
*Ini Files Editor (DefCore.txt, ActMap.txt etc)

All editors provided by C4DT offer suitable syntax highlighting. Apart from that they include special support for the types of files they were intended for:
*The C4Script Editor is supposed to help you write scripts more quickly by displaying errors and warnings contained in the script as soon as you save them and offering you a list of identifiers you can insert in specific places. It also tries to make writing properly formatted scripts easier by automatically inserting closing brackets and indenting. In addition to that it also strives to make navigation among and inside scripts easier by hyperlinking between them and providing an outline of the script.
*The Landscape.txt Editor is tailored for editing - surprise! - Landscape.txt files. Sadly, it doesn't offer a live preview on how the generated map would look like so it's probably a good idea to use Mape instead. There are plans to include similar functionality directly in Eclipse though.
*The Ini Files Editor also includes support for hyperlinks.
==Navigation==
Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
*[[File:Eclipse_Hyperlinks.png|right]] '''Hyperlinks''': All valid identifiers can be turned into links by pressing Ctrl/⌘ while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png|right]] Identifiers in ini editors can also be turned into hyperlinks.
 
*[[File:Clonk_OpenObject.png|right]] '''Open Object Dialog''': The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.
 
[[File:Eclipse_BackForward.png|right]] '''Going back and forward''': When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar. On a Mac, you can also install [http://marketplace.eclipse.org/content/eclipse-multi-touch Eclipse Multitouch] to navigate back and forth using gestures.
 
[[File:Eclipse_DeclarationsFilter.png|right]]
'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.
 

==Getting Content Assistance==
When you are editing a script you can invoke a list offering you identifiers to insert. This list is context-sensitive so it will display different options depending on whether the cursor is inside a function or not or whether you are invoking it after having written '->'. The short cut for the Content Assist list is Ctrl+Space but like any other short cut it can be changed in the preferences.
[[File:Eclipse_ContentAssist.png]] 

==Improvements compared to generic text editors==
The C4Script editor adds special behaviour for some situations. Those are:
*[[File:Eclipse_AutomaticBlock.png|right]] Automatic block: When typing '{' and then pressing Return a block will be created automatically and the caret will be placed inside the block indented by one tab. 
*[[File:Eclipse_AutomaticParmBrackets.png|right]] When you type '(' or '[' the corresponding closing bracket will be automatically inserted. In order to not interrupt your typing those inserted closing brackets will be overridden if you type them by hand subsequently. In this special situation, pressing tab will cause the caret to jump over the closing bracket. 
*[[File:Eclipse_ParmHint.png|right]]Parameter hints: As soon as you enter the brackets of a function call the parameters will be displayed above, not at all by chance similar to C4Scripter. The mechanism to find the right parameters to display is kind of smart and will also work when calling a function on an object using '->' as long as C4DT can deduce the object type of the expression left to '->'. 
*[[File:Eclipse_AutoFunction.png|right]] When you want to declare a new function you can type the name and then invoke Content Assistance (Ctrl+Space). A function block will be created for you.

==Outline==
[[File:Eclipse_Outline.png|right]] C4DT Editors fill the Outline view with an outline of the files being edited. The default Clonk perspective places the outline on the left below the Project Explorer.
The outline allows you to filter the list of declarations using a regular expression or wildcard.
 

==Errors & Warnings==
[[File:Eclipse_ProblemsView.png|right]] The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.
For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].
 
Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.
[[File:Eclipse_ProblemsFilter.png]]

==Quick Fixes==
[[File:Eclipse_QuickFix.png|right]]
For certain common cases of errors, c4dt offers automatic quick fixes which are offered to you when you press Ctrl/⌘+1 while having the cursor in a script inside a region marked as erroneous/problematic.

==Additional Views==
C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.
*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

C4DT Editors

2011-10-16T20:04:40Z

Mortimer: Add note about Quick Fixes

==Introduction==
As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.
Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.
Eclipse provides different internal editors for different file types. For Clonk-specific files, C4DT adds some more to the list. Among those are a
*C4Script Editor
*Landscape.txt Editor
*Ini Files Editor (DefCore.txt, ActMap.txt etc)

All editors provided by C4DT offer suitable syntax highlighting. Apart from that they include special support for the types of files they were intended for:
*The C4Script Editor is supposed to help you write scripts more quickly by displaying errors and warnings contained in the script as soon as you save them and offering you a list of identifiers you can insert in specific places. It also tries to make writing properly formatted scripts easier by automatically inserting closing brackets and indenting. In addition to that it also strives to make navigation among and inside scripts easier by hyperlinking between them and providing an outline of the script.
*The Landscape.txt Editor is tailored for editing - surprise! - Landscape.txt files. Sadly, it doesn't offer a live preview on how the generated map would look like so it's probably a good idea to use Mape instead. There are plans to include similar functionality directly in Eclipse though.
*The Ini Files Editor also includes support for hyperlinks.
==Navigation==
Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
*[[File:Eclipse_Hyperlinks.png|right]] '''Hyperlinks''': All valid identifiers can be turned into links by pressing Ctrl/⌘ while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png|right]] Identifiers in ini editors can also be turned into hyperlinks.
 
*[[File:Clonk_OpenObject.png|right]] '''Open Object Dialog''': The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.
 
[[File:Eclipse_BackForward.png|right]] '''Going back and forward''': When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar. On a Mac, you can also install [http://marketplace.eclipse.org/content/eclipse-multi-touch Eclipse Multitouch] to navigate back and forth using gestures.
 
[[File:Eclipse_DeclarationsFilter.png|right]]
'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.
 

==Getting Content Assistance==
When you are editing a script you can invoke a list offering you identifiers to insert. This list is context-sensitive so it will display different options depending on whether the cursor is inside a function or not or whether you are invoking it after having written '->'. The short cut for the Content Assist list is Ctrl+Space but like any other short cut it can be changed in the preferences.
[[File:Eclipse_ContentAssist.png]] 

==Improvements compared to generic text editors==
The C4Script editor adds special behaviour for some situations. Those are:
*[[File:Eclipse_AutomaticBlock.png|right]] Automatic block: When typing '{' and then pressing Return a block will be created automatically and the caret will be placed inside the block indented by one tab. 
*[[File:Eclipse_AutomaticParmBrackets.png|right]] When you type '(' or '[' the corresponding closing bracket will be automatically inserted. In order to not interrupt your typing those inserted closing brackets will be overridden if you type them by hand subsequently. In this special situation, pressing tab will cause the caret to jump over the closing bracket. 
*[[File:Eclipse_ParmHint.png|right]]Parameter hints: As soon as you enter the brackets of a function call the parameters will be displayed above, not at all by chance similar to C4Scripter. The mechanism to find the right parameters to display is kind of smart and will also work when calling a function on an object using '->' as long as C4DT can deduce the object type of the expression left to '->'. 
*[[File:Eclipse_AutoFunction.png|right]] When you want to declare a new function you can type the name and then invoke Content Assistance (Ctrl+Space). A function block will be created for you.

==Outline==
[[File:Eclipse_Outline.png|right]] C4DT Editors fill the Outline view with an outline of the files being edited. The default Clonk perspective places the outline on the left below the Project Explorer.
The outline allows you to filter the list of declarations using a regular expression or wildcard.
 

==Errors & Warnings==
[[File:Eclipse_ProblemsView.png|right]] The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.
For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].
 
Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.
[[File:Eclipse_ProblemsFilter.png]]

==Additional Views==
C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.
*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

==Quick Fixes==
[[File:Eclipse_QuickFix.png|right]]
For certain common cases of errors, c4dt offers automatic quick fixes which are offered to you when you press Ctrl/⌘+1 while having the cursor in a script inside a region marked as erroneous/problematic.

File:Eclipse QuickFix.png

2011-10-16T20:03:39Z

Mortimer:

C4DT Editors

2011-10-16T20:00:01Z

Mortimer: clear all for good measure!

==Introduction==
As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.
Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.
Eclipse provides different internal editors for different file types. For Clonk-specific files, C4DT adds some more to the list. Among those are a
*C4Script Editor
*Landscape.txt Editor
*Ini Files Editor (DefCore.txt, ActMap.txt etc)

All editors provided by C4DT offer suitable syntax highlighting. Apart from that they include special support for the types of files they were intended for:
*The C4Script Editor is supposed to help you write scripts more quickly by displaying errors and warnings contained in the script as soon as you save them and offering you a list of identifiers you can insert in specific places. It also tries to make writing properly formatted scripts easier by automatically inserting closing brackets and indenting. In addition to that it also strives to make navigation among and inside scripts easier by hyperlinking between them and providing an outline of the script.
*The Landscape.txt Editor is tailored for editing - surprise! - Landscape.txt files. Sadly, it doesn't offer a live preview on how the generated map would look like so it's probably a good idea to use Mape instead. There are plans to include similar functionality directly in Eclipse though.
*The Ini Files Editor also includes support for hyperlinks.
==Navigation==
Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
*[[File:Eclipse_Hyperlinks.png|right]] '''Hyperlinks''': All valid identifiers can be turned into links by pressing Ctrl/⌘ while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png|right]] Identifiers in ini editors can also be turned into hyperlinks.
 
*[[File:Clonk_OpenObject.png|right]] '''Open Object Dialog''': The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.
 
[[File:Eclipse_BackForward.png|right]] '''Going back and forward''': When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar. On a Mac, you can also install [http://marketplace.eclipse.org/content/eclipse-multi-touch Eclipse Multitouch] to navigate back and forth using gestures.
 
[[File:Eclipse_DeclarationsFilter.png|right]]
'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.
 

==Getting Content Assistance==
When you are editing a script you can invoke a list offering you identifiers to insert. This list is context-sensitive so it will display different options depending on whether the cursor is inside a function or not or whether you are invoking it after having written '->'. The short cut for the Content Assist list is Ctrl+Space but like any other short cut it can be changed in the preferences.
[[File:Eclipse_ContentAssist.png]] 

==Improvements compared to generic text editors==
The C4Script editor adds special behaviour for some situations. Those are:
*[[File:Eclipse_AutomaticBlock.png|right]] Automatic block: When typing '{' and then pressing Return a block will be created automatically and the caret will be placed inside the block indented by one tab. 
*[[File:Eclipse_AutomaticParmBrackets.png|right]] When you type '(' or '[' the corresponding closing bracket will be automatically inserted. In order to not interrupt your typing those inserted closing brackets will be overridden if you type them by hand subsequently. In this special situation, pressing tab will cause the caret to jump over the closing bracket. 
*[[File:Eclipse_ParmHint.png|right]]Parameter hints: As soon as you enter the brackets of a function call the parameters will be displayed above, not at all by chance similar to C4Scripter. The mechanism to find the right parameters to display is kind of smart and will also work when calling a function on an object using '->' as long as C4DT can deduce the object type of the expression left to '->'. 
*[[File:Eclipse_AutoFunction.png|right]] When you want to declare a new function you can type the name and then invoke Content Assistance (Ctrl+Space). A function block will be created for you.

==Outline==
[[File:Eclipse_Outline.png|right]] C4DT Editors fill the Outline view with an outline of the files being edited. The default Clonk perspective places the outline on the left below the Project Explorer.
The outline allows you to filter the list of declarations using a regular expression or wildcard.
 

==Errors & Warnings==
[[File:Eclipse_ProblemsView.png|right]] The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.
For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].
 
Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.
[[File:Eclipse_ProblemsFilter.png]]

==Additional Views==
C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.
*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

C4DT Editors

2011-10-16T19:59:10Z

Mortimer: Add short description of Clonk Folder view

==Introduction==
As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.
Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.
Eclipse provides different internal editors for different file types. For Clonk-specific files, C4DT adds some more to the list. Among those are a
*C4Script Editor
*Landscape.txt Editor
*Ini Files Editor (DefCore.txt, ActMap.txt etc)

All editors provided by C4DT offer suitable syntax highlighting. Apart from that they include special support for the types of files they were intended for:
*The C4Script Editor is supposed to help you write scripts more quickly by displaying errors and warnings contained in the script as soon as you save them and offering you a list of identifiers you can insert in specific places. It also tries to make writing properly formatted scripts easier by automatically inserting closing brackets and indenting. In addition to that it also strives to make navigation among and inside scripts easier by hyperlinking between them and providing an outline of the script.
*The Landscape.txt Editor is tailored for editing - surprise! - Landscape.txt files. Sadly, it doesn't offer a live preview on how the generated map would look like so it's probably a good idea to use Mape instead. There are plans to include similar functionality directly in Eclipse though.
*The Ini Files Editor also includes support for hyperlinks.
==Navigation==
Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
*[[File:Eclipse_Hyperlinks.png|right]] '''Hyperlinks''': All valid identifiers can be turned into links by pressing Ctrl/⌘ while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png|right]] Identifiers in ini editors can also be turned into hyperlinks.
 
*[[File:Clonk_OpenObject.png|right]] '''Open Object Dialog''': The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.
 
[[File:Eclipse_BackForward.png|right]] '''Going back and forward''': When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar. On a Mac, you can also install [http://marketplace.eclipse.org/content/eclipse-multi-touch Eclipse Multitouch] to navigate back and forth using gestures.
 
[[File:Eclipse_DeclarationsFilter.png|right]]
'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.

==Getting Content Assistance==
When you are editing a script you can invoke a list offering you identifiers to insert. This list is context-sensitive so it will display different options depending on whether the cursor is inside a function or not or whether you are invoking it after having written '->'. The short cut for the Content Assist list is Ctrl+Space but like any other short cut it can be changed in the preferences.
[[File:Eclipse_ContentAssist.png]] 

==Improvements compared to generic text editors==
The C4Script editor adds special behaviour for some situations. Those are:
*[[File:Eclipse_AutomaticBlock.png|right]] Automatic block: When typing '{' and then pressing Return a block will be created automatically and the caret will be placed inside the block indented by one tab. 
*[[File:Eclipse_AutomaticParmBrackets.png|right]] When you type '(' or '[' the corresponding closing bracket will be automatically inserted. In order to not interrupt your typing those inserted closing brackets will be overridden if you type them by hand subsequently. In this special situation, pressing tab will cause the caret to jump over the closing bracket. 
*[[File:Eclipse_ParmHint.png|right]]Parameter hints: As soon as you enter the brackets of a function call the parameters will be displayed above, not at all by chance similar to C4Scripter. The mechanism to find the right parameters to display is kind of smart and will also work when calling a function on an object using '->' as long as C4DT can deduce the object type of the expression left to '->'. 
*[[File:Eclipse_AutoFunction.png|right]] When you want to declare a new function you can type the name and then invoke Content Assistance (Ctrl+Space). A function block will be created for you.

==Outline==
[[File:Eclipse_Outline.png|right]] C4DT Editors fill the Outline view with an outline of the files being edited. The default Clonk perspective places the outline on the left below the Project Explorer.
The outline allows you to filter the list of declarations using a regular expression or wildcard.
 

==Errors & Warnings==
[[File:Eclipse_ProblemsView.png|right]] The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.
For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].
 
Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.
[[File:Eclipse_ProblemsFilter.png]]

==Additional Views==
C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.
*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.
*The Clonk Folder view enables quick access to packed c4group files inside the game folder of the engine set for the project whose files you are currently editing.

C4DT Editors

2011-10-16T19:57:54Z

Mortimer: add description about Lookup Declaration

==Introduction==
As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.
Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.
Eclipse provides different internal editors for different file types. For Clonk-specific files, C4DT adds some more to the list. Among those are a
*C4Script Editor
*Landscape.txt Editor
*Ini Files Editor (DefCore.txt, ActMap.txt etc)

All editors provided by C4DT offer suitable syntax highlighting. Apart from that they include special support for the types of files they were intended for:
*The C4Script Editor is supposed to help you write scripts more quickly by displaying errors and warnings contained in the script as soon as you save them and offering you a list of identifiers you can insert in specific places. It also tries to make writing properly formatted scripts easier by automatically inserting closing brackets and indenting. In addition to that it also strives to make navigation among and inside scripts easier by hyperlinking between them and providing an outline of the script.
*The Landscape.txt Editor is tailored for editing - surprise! - Landscape.txt files. Sadly, it doesn't offer a live preview on how the generated map would look like so it's probably a good idea to use Mape instead. There are plans to include similar functionality directly in Eclipse though.
*The Ini Files Editor also includes support for hyperlinks.
==Navigation==
Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
*[[File:Eclipse_Hyperlinks.png|right]] '''Hyperlinks''': All valid identifiers can be turned into links by pressing Ctrl/⌘ while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png|right]] Identifiers in ini editors can also be turned into hyperlinks.
 
*[[File:Clonk_OpenObject.png|right]] '''Open Object Dialog''': The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text.
 
[[File:Eclipse_BackForward.png|right]] '''Going back and forward''': When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar. On a Mac, you can also install [http://marketplace.eclipse.org/content/eclipse-multi-touch Eclipse Multitouch] to navigate back and forth using gestures.
 
[[File:Eclipse_DeclarationsFilter.png|right]]
'''Lookup Declaration''': From any script or when having selected a file in the project explorer, you can invoke Lookup Declaration from the Clonk menu (also a candidate for a nice keyboard assignment). You can then filter all the declarations from the current selection (either the project selected in the project explorer or the script being currently edited including its #includes) using regular expressions and jump to the declaration of any identifier matched by the expression.

==Getting Content Assistance==
When you are editing a script you can invoke a list offering you identifiers to insert. This list is context-sensitive so it will display different options depending on whether the cursor is inside a function or not or whether you are invoking it after having written '->'. The short cut for the Content Assist list is Ctrl+Space but like any other short cut it can be changed in the preferences.
[[File:Eclipse_ContentAssist.png]] 

==Improvements compared to generic text editors==
The C4Script editor adds special behaviour for some situations. Those are:
*[[File:Eclipse_AutomaticBlock.png|right]] Automatic block: When typing '{' and then pressing Return a block will be created automatically and the caret will be placed inside the block indented by one tab. 
*[[File:Eclipse_AutomaticParmBrackets.png|right]] When you type '(' or '[' the corresponding closing bracket will be automatically inserted. In order to not interrupt your typing those inserted closing brackets will be overridden if you type them by hand subsequently. In this special situation, pressing tab will cause the caret to jump over the closing bracket. 
*[[File:Eclipse_ParmHint.png|right]]Parameter hints: As soon as you enter the brackets of a function call the parameters will be displayed above, not at all by chance similar to C4Scripter. The mechanism to find the right parameters to display is kind of smart and will also work when calling a function on an object using '->' as long as C4DT can deduce the object type of the expression left to '->'. 
*[[File:Eclipse_AutoFunction.png|right]] When you want to declare a new function you can type the name and then invoke Content Assistance (Ctrl+Space). A function block will be created for you.

==Outline==
[[File:Eclipse_Outline.png|right]] C4DT Editors fill the Outline view with an outline of the files being edited. The default Clonk perspective places the outline on the left below the Project Explorer.
The outline allows you to filter the list of declarations using a regular expression or wildcard.
 

==Errors & Warnings==
[[File:Eclipse_ProblemsView.png|right]] The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.
For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].
 
Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.
[[File:Eclipse_ProblemsFilter.png]]

==Additional Views==
C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.
*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.

File:Eclipse DeclarationsFilter.png

2011-10-16T19:45:20Z

Mortimer:

C4DT Editors

2011-10-16T19:43:35Z

Mortimer: /* Errors & Warnings */

==Introduction==
As of now, you should have created an OpenClonk project and be sitting in front of something that is quite comparable to the original Clonk Editor. On the left side you have the Project Explorer (or on the right side or wherever you like, since all views can be freely arranged in Eclipse). You can use it to navigate packets as you'd do when using the editor.
Unlike the editor though, files are generally openend not it an external program but in a tab in the Eclipse window. You can still set programs to handle specific files by either using the Open With command in the context menu of the Project Explorer or by setting a program in the preferences. The first method works on a file-by-file basis so you could tell Eclipse to open a specific graphics file with Photoshop while opening others with Paint. The second method (Preferences -> General -> Editors -> File Associations) sets a file association for all files of that type.
Eclipse provides different internal editors for different file types. For Clonk-specific files, C4DT adds some more to the list. Among those are a
*C4Script Editor
*Landscape.txt Editor
*Ini Files Editor (DefCore.txt, ActMap.txt etc)

All editors provided by C4DT offer suitable syntax highlighting. Apart from that they include special support for the types of files they were intended for:
*The C4Script Editor is supposed to help you write scripts more quickly by displaying errors and warnings contained in the script as soon as you save them and offering you a list of identifiers you can insert in specific places. It also tries to make writing properly formatted scripts easier by automatically inserting closing brackets and indenting. In addition to that it also strives to make navigation among and inside scripts easier by hyperlinking between them and providing an outline of the script.
*The Landscape.txt Editor is tailored for editing - surprise! - Landscape.txt files. Sadly, it doesn't offer a live preview on how the generated map would look like so it's probably a good idea to use Mape instead. There are plans to include similar functionality directly in Eclipse though.
*The Ini Files Editor also includes support for hyperlinks.
==Navigation==
Navigating to and between scripts quickly is very important. Because of that, C4DT adds several navigation features:
*[[File:Eclipse_Hyperlinks.png|right]] Hyperlinks: All valid identifiers can be turned into links by pressing Ctrl while hovering over the identifier with your mouse. When you click on them the declaration location of the thing the identifier is referring to will be opened. This works for variables, functions, definitions and also for StringTbl entries ($BlaBla$). [[File:Eclipse_HyperlinksIni.png|right]] Identifiers in ini editors can also be turned into hyperlinks. 
*[[File:Clonk_OpenObject.png|right]] Open Object Dialog: The Open Object dialog can be activated using the Clonk menu in the main menu. As soon as you start typing the dialog starts listing definitions that match the typed text. 
*[[File:Eclipse_BackForward.png|right]] Going back and forward: When clicking on hyperlinks or navigating to other files by any other means you will always be able to go back to the original file by either pressing Alt+Left or using the yellow arrows in the toolbar.

==Getting Content Assistance==
When you are editing a script you can invoke a list offering you identifiers to insert. This list is context-sensitive so it will display different options depending on whether the cursor is inside a function or not or whether you are invoking it after having written '->'. The short cut for the Content Assist list is Ctrl+Space but like any other short cut it can be changed in the preferences.
[[File:Eclipse_ContentAssist.png]] 

==Improvements compared to generic text editors==
The C4Script editor adds special behaviour for some situations. Those are:
*[[File:Eclipse_AutomaticBlock.png|right]] Automatic block: When typing '{' and then pressing Return a block will be created automatically and the caret will be placed inside the block indented by one tab. 
*[[File:Eclipse_AutomaticParmBrackets.png|right]] When you type '(' or '[' the corresponding closing bracket will be automatically inserted. In order to not interrupt your typing those inserted closing brackets will be overridden if you type them by hand subsequently. In this special situation, pressing tab will cause the caret to jump over the closing bracket. 
*[[File:Eclipse_ParmHint.png|right]]Parameter hints: As soon as you enter the brackets of a function call the parameters will be displayed above, not at all by chance similar to C4Scripter. The mechanism to find the right parameters to display is kind of smart and will also work when calling a function on an object using '->' as long as C4DT can deduce the object type of the expression left to '->'. 
*[[File:Eclipse_AutoFunction.png|right]] When you want to declare a new function you can type the name and then invoke Content Assistance (Ctrl+Space). A function block will be created for you.

==Outline==
[[File:Eclipse_Outline.png|right]] C4DT Editors fill the Outline view with an outline of the files being edited. The default Clonk perspective places the outline on the left below the Project Explorer.
The outline allows you to filter the list of declarations using a regular expression or wildcard.
 

==Errors & Warnings==
[[File:Eclipse_ProblemsView.png|right]] The script parser built into C4DT tries to detect lots of potential and actual errors, which are listed in the problems view. A script is reparsed when it gets saved. In some cases errors might become stale and won't get removed from the list automatically. What you can then do is Clean the project using Project -> Clean. This will reparse all the scripts in either the entire workspace or specific projects and hopefully remove the false errors.
For a list of warnings & errors take a look at [http://bitbucket.org/mortimer/c4dt/src/tip/C4DT/src/net/arctics/clonk/parser/ParserErrorCode.java ParserErrorCode.java].
 
Errors and Warnings listed in the Problems View can be individually deactivated if they annoy you. To do that, open up the properties window for the project you want to configure, select the Clonk category and deactivate kinds of errors/warnings to your heart's content.
[[File:Eclipse_ProblemsFilter.png]]

==Additional Views==
C4DT adds a handful of views. Two of them will get placed in the same tabzone as the Outline view by the Clonk perspective.
*The Preview view serves as a replacement for the preview feature found in the Clonk Editor.

File:Eclipse ProblemsFilter.png

2011-10-16T19:43:09Z

Mortimer: uploaded a new version of "File:Eclipse ProblemsFilter.png"

File:Eclipse ProblemsFilter.png

2011-10-16T19:38:47Z

Mortimer:

C4DT Editors

2011-10-16T19:32:42Z

Mortimer: /* Outline */

File:Eclipse Outline.png

2011-10-16T19:31:26Z

Mortimer: uploaded a new version of "File:Eclipse Outline.png"

Developing Content with Eclipse

2011-02-05T20:40:56Z

Mortimer:

== Introduction ==

Eclipse is an extensible opensource IDE written in Java. It can be obtained from [http://eclipse.org/downloads/ here]. For the purpose of Clonk development the ''Eclipse IDE for Java Developers'' package will do. In order for Eclipse to be aware of C4Scripts and other Clonk-related files a plugin has to be installed. An explanation on how to do that can be found in the [[C4DT Installation Guide]]. Below is a list of tutorials to introduce you to C4DT, the Clonk Development Tools for Eclipse.

== Tutorials ==
* [[C4DT Installation Guide|Installation]]
* [[C4DT Editors|Editors]]
* [[C4DT Running Scenarios|Running Scenarios]]

== FAQ ==
* [[C4DT_FAQ|Frequently Asked Questions]]

C4DT FAQ

2011-02-05T20:40:50Z

Mortimer: Add png problem

==Eclipse corrupts my png files when I edit them in a graphics program==
You can go to Preferences -> General -> Editors -> File Associations and add a new file association for *.png files to ensure that png will always be opened in an external editor of your choice and not in an editor tab inside Eclipse.

C4DT Installation Guide

2010-12-21T16:05:57Z

Mortimer: Add "Getting OpenClonk content into Eclipse" section

==Prerequisites==
First you need to install Eclipse itself. This is relatively straightforward. Go to the [http://eclipse.org/downloads/ Eclipse Download Page] and download the ''Eclipse for Java Developers'' package. Eclipse does not require running an installer. Just unpack the folder somewhere and run the Eclipse program inside it. Unless you don't have Java installed Eclipse should boot although that might take a while. On first boot, Eclipse will usually ask you to provide a workspace location. That's the folder Eclipse will create projects in by default. Set it as you like.

==Installing C4DT==
Installing C4DT (Clonk Development Tools) is the next step to tailor that generic Eclipse installation you now have for the purpose of editing C4Scripts and other OpenClonk files with it. It is a plug-in that provides a number of improvements you might know from other IDEs. Among those are
* Content Assistance (similar to IntelliSense from Visual Studio)
* Error recognition (to not have to boot up the engine for getting a list of syntax errors)
* Navigation (clicking on identifiers, getting to their declaration locations)
* Debugging scripts (suspending execution of scripts, executing them in single steps)
To install C4DT, you first have to add its update site to the list of update sites Eclipse is maintaining. An update site is a location (usually on some web site although it can be local as well) Eclipse can download plug ins from. Once downloaded, those plug ins will also be updated from the same update site if Eclipse finds new versions of the plug-in there. To add an update site, go to Help -> Install New Software and press the Add button in the Install window.
[[File:Eclipse_InstallWindow.png|left]] 

C4DT's Update Site is currently [http://www.maltworld.de/clonk/c4dt/update http://www.maltworld.de/clonk/c4dt/update] but that might change in the future. Add the Update Site (the name you choose for the site is of no concern), select it if that didn't happen automatically and you should see two items for installation:
[[File:EclipseAvailableFeatures.png|left]] 
The first one is the C4DT plugin itself that contains all the functionality. The second one is a German language pack you can optionally install as well. Note though that only functionality added by C4DT is translated. The rest of Eclipse stays in English. To change that, head over to the [http://www.eclipse.org/babel/downloads.php Eclipse Babel Project] and install language packs from there. After pressing "Next" quite a few times, accepting the license (which is supposed to be the same as the one OpenClonk uses), agreeing to install unsigned content and restarting Eclipse, C4DT should be installed. A sign of success would be having a Clonk menu item in the main menu.

==Setting Eclipse up for Clonk development==
[[File:Eclipse_ChoosePerspective.png|right]] Now that C4DT is installed Eclipse needs to be set into Clonk mode. Press the button in the top-right of the window and "Other...". [[File:Eclipse_Perspectives.png|border|right]] You should see a window listing the available perspectives Eclipse can be put into. Choose the one named "Clonk". 
In Eclipse lingo, a perspective is a default configuration on what views the main window should contain and how those views are arranged. There are perspectives for working on various tasks, like synchronizing code with a repository or working on a Java project. C4DT adds a Clonk perspective that by default looks like this: 
[[File:Eclipse_DefaultClonkPerspective.png|border]] 

==Initial configuration==
What now needs to be done is setting some default preferences that C4DT will need to not completely screw up. Open up the preferences (Window -> Preferences) and go to the Clonk section: 
[[File:Eclipse_ClonkPreferences.png|left]] 
The preferences are divided into preferences to control the general behaviour of the plug-in (below) and engine-specific preferences (on top).
Set the game path for OpenClonk to the planet folder in your repository.
The two fields "C4Group Executable" and "Engine" will be filled out automatically if suitable executables are contained in the planet folder. If those are to be found somewhere else in your case, select them manually.
The repository field isn't exactly needed at the moment but you can set it to the path to your repository (not the planet folder) anyway.
This is all you need to set in the preferences but of course you can configure other things to your liking. Specifying Syntax highlighting colours used in Clonk text editors (expand the Clonk item in the tree view on the right) or keyboard short cuts (General -> Keys) come to mind.
When you're done, press OK.

==Getting OpenClonk content into Eclipse==
Now notice the Project Explorer view. It's glaringly empty. To fill it with OpenClonk content, open up the Clonk project wizard by pressing File -> New Clonk Project.
[[File:Eclipse_NewClonkProject.png|left]] 
Choose the name of the project. "OpenClonk" is advisable but in the end it's up to your preference.

The following steps differ based on whether you cloned the OpenClonk repository or downloaded an official release.

* '''Cloned from Repository'''
:Eclipse will create projects in its workspace folder. But in the case of OpenClonk this is not suitable since all the game content is contained in the planet folder. Luckily, Eclipse provides a mechanism for such situations. It allows you to create projects from folders arbitrarily located in the file system. To use that mechanism uncheck "Use default location" and provide the path to the planet folder. This might feel kind of redundant since you already specified that path in the preferences and well, it is.

* '''Downloaded official release'''
:C4Groups in the official release are packed. C4DT can read packed c4groups, but not modify them. To access the content of packed groups, you have two choices. You can
:* ''link to those groups.''
::For that purpose, there is a link tab in the Clonk Project Wizard that enables you to add groups to be linked to the new project. Add all the .c4d/.c4f/.c4g files from the OpenClonk installation. When you finish the wizard later on, the linked groups will be displayed like regular folders, except for a link sign on the icon ([[File:EclipseLinkedGroup.png]])
::To actually edit stuff, you need to create a new project that references the project containing the linked c4groups. Actually, this is not strictly necessary but advisable to keep things clear.
::For referencing other projects (making stuff defined in that project known to the other project), use the Project References tab in the wizard. For changing project references later on, open the properties of a project (right click on the project in the Project Explorer, then select "Properties") and go to the Project References section.
:* ''import the groups.''
::The groups will be unpacked into the Eclipse workspace folder and modifying the unpacked files there won't be modify the original groups. Add groups to be imported from the Importing tab in the wizard.
::If you plan on modyifing content from the releases you could think about whether it wouldn't be better to clone from the repository so you will be able to track your modifications using version control.
* '''Both'''
:Next, you should set the engine to "Open Clonk". When leaving it set to "Default engine" the project's engine will always be equal to the one selected in the preferences which might be troublesome when mixing Clonk Rage and Open Clonk projects in one workspace.

==The Result==
After creating the OpenClonk project and waiting a bit for Eclipse to analyze all the scripts you should be presented with a vista such as this:
[[File:Eclipse_OpenClonkProjectCreated.png]] 
In its current state, C4DT should more or less be able to parse all the scripts and not litter the problems view with false positives. When new functions are added to the engine (which tends to happen quite a lot with an engine still in development) those functions will be unknown to Eclipse at first, hence its complaining. But fear not, as those gaping holes of ignorance will sooner or later be stuffed.

C4DT Installation Guide

2010-12-21T16:00:58Z

Mortimer: Clarify linking/importing a bit more

==Prerequisites==
First you need to install Eclipse itself. This is relatively straightforward. Go to the [http://eclipse.org/downloads/ Eclipse Download Page] and download the ''Eclipse for Java Developers'' package. Eclipse does not require running an installer. Just unpack the folder somewhere and run the Eclipse program inside it. Unless you don't have Java installed Eclipse should boot although that might take a while. On first boot, Eclipse will usually ask you to provide a workspace location. That's the folder Eclipse will create projects in by default. Set it as you like.

==Installing C4DT==
Installing C4DT (Clonk Development Tools) is the next step to tailor that generic Eclipse installation you now have for the purpose of editing C4Scripts and other OpenClonk files with it. It is a plug-in that provides a number of improvements you might know from other IDEs. Among those are
* Content Assistance (similar to IntelliSense from Visual Studio)
* Error recognition (to not have to boot up the engine for getting a list of syntax errors)
* Navigation (clicking on identifiers, getting to their declaration locations)
* Debugging scripts (suspending execution of scripts, executing them in single steps)
To install C4DT, you first have to add its update site to the list of update sites Eclipse is maintaining. An update site is a location (usually on some web site although it can be local as well) Eclipse can download plug ins from. Once downloaded, those plug ins will also be updated from the same update site if Eclipse finds new versions of the plug-in there. To add an update site, go to Help -> Install New Software and press the Add button in the Install window.
[[File:Eclipse_InstallWindow.png|left]] 

C4DT's Update Site is currently [http://www.maltworld.de/clonk/c4dt/update http://www.maltworld.de/clonk/c4dt/update] but that might change in the future. Add the Update Site (the name you choose for the site is of no concern), select it if that didn't happen automatically and you should see two items for installation:
[[File:EclipseAvailableFeatures.png|left]] 
The first one is the C4DT plugin itself that contains all the functionality. The second one is a German language pack you can optionally install as well. Note though that only functionality added by C4DT is translated. The rest of Eclipse stays in English. To change that, head over to the [http://www.eclipse.org/babel/downloads.php Eclipse Babel Project] and install language packs from there. After pressing "Next" quite a few times, accepting the license (which is supposed to be the same as the one OpenClonk uses), agreeing to install unsigned content and restarting Eclipse, C4DT should be installed. A sign of success would be having a Clonk menu item in the main menu.

==Setting Eclipse up for Clonk development==
[[File:Eclipse_ChoosePerspective.png|right]] Now that C4DT is installed Eclipse needs to be set into Clonk mode. Press the button in the top-right of the window and "Other...". [[File:Eclipse_Perspectives.png|border|right]] You should see a window listing the available perspectives Eclipse can be put into. Choose the one named "Clonk". 
In Eclipse lingo, a perspective is a default configuration on what views the main window should contain and how those views are arranged. There are perspectives for working on various tasks, like synchronizing code with a repository or working on a Java project. C4DT adds a Clonk perspective that by default looks like this: 
[[File:Eclipse_DefaultClonkPerspective.png|border]] 

==Initial configuration==
What now needs to be done is setting some default preferences that C4DT will need to not completely screw up. Open up the preferences (Window -> Preferences) and go to the Clonk section: 
[[File:Eclipse_ClonkPreferences.png|left]] 
The preferences are divided into preferences to control the general behaviour of the plug-in (below) and engine-specific preferences (on top).
Set the game path for OpenClonk to the planet folder in your repository.
The two fields "C4Group Executable" and "Engine" will be filled out automatically if suitable executables are contained in the planet folder. If those are to be found somewhere else in your case, select them manually.
The repository field isn't exactly needed at the moment but you can set it to the path to your repository (not the planet folder) anyway.
This is all you need to set in the preferences but of course you can configure other things to your liking. Specifying Syntax highlighting colours used in Clonk text editors (expand the Clonk item in the tree view on the right) or keyboard short cuts (General -> Keys) come to mind.
When you're done, press OK.
Now notice the Project Explorer view. It's glaringly empty. To fill it with OpenClonk content, open up the Clonk project wizard by pressing File -> New Clonk Project.
[[File:Eclipse_NewClonkProject.png|left]] 
Choose the name of the project. "OpenClonk" is advisable but in the end it's up to your preference.
The following steps differ based on whether you cloned the OpenClonk repository or downloaded an official release.

* '''Cloned from Repository'''
:Eclipse will create projects in its workspace folder. But in the case of OpenClonk this is not suitable since all the game content is contained in the planet folder. Luckily, Eclipse provides a mechanism for such situations. It allows you to create projects from folders arbitrarily located in the file system. To use that mechanism uncheck "Use default location" and provide the path to the planet folder. This might feel kind of redundant since you already specified that path in the preferences and well, it is.

* '''Downloaded official release'''
:C4Groups in the official release are packed. C4DT can read packed c4groups, but not modify them. To access the content of packed groups, you have two choices. You can
:* ''link to those groups.''
::For that purpose, there is a link tab in the Clonk Project Wizard that enables you to add groups to be linked to the new project. Add all the .c4d/.c4f/.c4g files from the OpenClonk installation. When you finish the wizard later on, the linked groups will be displayed like regular folders, except for a link sign on the icon ([[File:EclipseLinkedGroup.png]])
::To actually edit stuff, you need to create a new project that references the project containing the linked c4groups. Actually, this is not strictly necessary but advisable to keep things clear.
::For referencing other projects (making stuff defined in that project known to the other project), use the Project References tab in the wizard. For changing project references later on, open the properties of a project (right click on the project in the Project Explorer, then select "Properties") and go to the Project References section.
:* ''import the groups.''
::The groups will be unpacked into the Eclipse workspace folder and modifying the unpacked files there won't be modify the original groups. Add groups to be imported from the Importing tab in the wizard.
::If you plan on modyifing content from the releases you could think about whether it wouldn't be better to clone from the repository so you will be able to track your modifications using version control.
* '''Both'''
:Next, you should set the engine to "Open Clonk". When leaving it set to "Default engine" the project's engine will always be equal to the one selected in the preferences which might be troublesome when mixing Clonk Rage and Open Clonk projects in one workspace.

==The Result==
After creating the OpenClonk project and waiting a bit for Eclipse to analyze all the scripts you should be presented with a vista such as this:
[[File:Eclipse_OpenClonkProjectCreated.png]] 
In its current state, C4DT should more or less be able to parse all the scripts and not litter the problems view with false positives. When new functions are added to the engine (which tends to happen quite a lot with an engine still in development) those functions will be unknown to Eclipse at first, hence its complaining. But fear not, as those gaping holes of ignorance will sooner or later be stuffed.

File:EclipseLinkedGroup.png

2010-12-21T15:56:03Z

Mortimer: Shows how linked groups look like in Eclipse.

Shows how linked groups look like in Eclipse.

C4DT Installation Guide

2010-12-21T02:47:54Z

Mortimer: Add explanation on how to link to packed c4groups from releases

==Prerequisites==
First you need to install Eclipse itself. This is relatively straightforward. Go to the [http://eclipse.org/downloads/ Eclipse Download Page] and download the ''Eclipse for Java Developers'' package. Eclipse does not require running an installer. Just unpack the folder somewhere and run the Eclipse program inside it. Unless you don't have Java installed Eclipse should boot although that might take a while. On first boot, Eclipse will usually ask you to provide a workspace location. That's the folder Eclipse will create projects in by default. Set it as you like.

==Installing C4DT==
Installing C4DT (Clonk Development Tools) is the next step to tailor that generic Eclipse installation you now have for the purpose of editing C4Scripts and other OpenClonk files with it. It is a plug-in that provides a number of improvements you might know from other IDEs. Among those are
* Content Assistance (similar to IntelliSense from Visual Studio)
* Error recognition (to not have to boot up the engine for getting a list of syntax errors)
* Navigation (clicking on identifiers, getting to their declaration locations)
* Debugging scripts (suspending execution of scripts, executing them in single steps)
To install C4DT, you first have to add its update site to the list of update sites Eclipse is maintaining. An update site is a location (usually on some web site although it can be local as well) Eclipse can download plug ins from. Once downloaded, those plug ins will also be updated from the same update site if Eclipse finds new versions of the plug-in there. To add an update site, go to Help -> Install New Software and press the Add button in the Install window.
[[File:Eclipse_InstallWindow.png|left]] 

C4DT's Update Site is currently [http://www.maltworld.de/clonk/c4dt/update http://www.maltworld.de/clonk/c4dt/update] but that might change in the future. Add the Update Site (the name you choose for the site is of no concern), select it if that didn't happen automatically and you should see two items for installation:
[[File:EclipseAvailableFeatures.png|left]] 
The first one is the C4DT plugin itself that contains all the functionality. The second one is a German language pack you can optionally install as well. Note though that only functionality added by C4DT is translated. The rest of Eclipse stays in English. To change that, head over to the [http://www.eclipse.org/babel/downloads.php Eclipse Babel Project] and install language packs from there. After pressing "Next" quite a few times, accepting the license (which is supposed to be the same as the one OpenClonk uses), agreeing to install unsigned content and restarting Eclipse, C4DT should be installed. A sign of success would be having a Clonk menu item in the main menu.

==Setting Eclipse up for Clonk development==
[[File:Eclipse_ChoosePerspective.png|right]] Now that C4DT is installed Eclipse needs to be set into Clonk mode. Press the button in the top-right of the window and "Other...". [[File:Eclipse_Perspectives.png|border|right]] You should see a window listing the available perspectives Eclipse can be put into. Choose the one named "Clonk". 
In Eclipse lingo, a perspective is a default configuration on what views the main window should contain and how those views are arranged. There are perspectives for working on various tasks, like synchronizing code with a repository or working on a Java project. C4DT adds a Clonk perspective that by default looks like this: 
[[File:Eclipse_DefaultClonkPerspective.png|border]] 

==Initial configuration==
What now needs to be done is setting some default preferences that C4DT will need to not completely screw up. Open up the preferences (Window -> Preferences) and go to the Clonk section: 
[[File:Eclipse_ClonkPreferences.png|left]] 
The preferences are divided into preferences to control the general behaviour of the plug-in (below) and engine-specific preferences (on top).
Set the game path for OpenClonk to the planet folder in your repository.
The two fields "C4Group Executable" and "Engine" will be filled out automatically if suitable executables are contained in the planet folder. If those are to be found somewhere else in your case, select them manually.
The repository field isn't exactly needed at the moment but you can set it to the path to your repository (not the planet folder) anyway.
This is all you need to set in the preferences but of course you can configure other things to your liking. Specifying Syntax highlighting colours used in Clonk text editors (expand the Clonk item in the tree view on the right) or keyboard short cuts (General -> Keys) come to mind.
When you're done, press OK.
Now notice the Project Explorer view. It's glaringly empty. To fill it with OpenClonk content, open up the Clonk project wizard by pressing File -> New Clonk Project.
[[File:Eclipse_NewClonkProject.png|left]] 
Choose the name of the project. "OpenClonk" is advisable but in the end it's up to your preference.
The following steps differ based on whether you cloned the OpenClonk repository or downloaded an official release.

==1. Cloned from Repository==
Eclipse will create projects in its workspace folder. But in the case of OpenClonk this is not suitable since all the game content is contained in the planet folder. Luckily, Eclipse provides a mechanism for such situations. It allows you to create projects from folders arbitrarily located in the file system. To use that mechanism uncheck "Use default location" and provide the path to the planet folder. This might feel kind of redundant since you already specified that path in the preferences and well, it is.

==2. Downloaded official release==
C4Groups in the official release are packed. C4DT can read packed c4groups, but not modify them. To access packed groups, you need to "link" to those groups. For that purpose, there is a link tab in the Clonk Project Wizard that enables you to add groups to be linked to the new project. Add all the .c4d/.c4f/.c4g files from the OpenClonk installation.
To actually edit stuff, you need to create a new project that references the project containing the linked c4groups. Actually, this is not strictly necessary but advisable to keep things clear.
For referencing other projects (making stuff defined in that project known to the other project), use the Project References tab in the wizard. For changing project references later on, open the properties of a project (right click on the project in the Project Explorer, then select "Properties") and go to the Project References section.

==Both==
Next, you should set the engine to "Open Clonk". When leaving it set to "Default engine" the project's engine will always be equal to the one selected in the preferences which might be troublesome when mixing Clonk Rage and Open Clonk projects in one workspace.
Don't let yourself be confused by the boxes at the bottom of the wizard. Those will only be useful in cases where you have multiple projects that build on each other or need to import some packed groups. All not the case in OpenClonk.

==The Result==
After creating the OpenClonk project and waiting a bit for Eclipse to analyze all the scripts you should be presented with a vista such as this:
[[File:Eclipse_OpenClonkProjectCreated.png]] 
In its current state, C4DT should more or less be able to parse all the scripts and not litter the problems view with false positives. When new functions are added to the engine (which tends to happen quite a lot with an engine still in development) those functions will be unknown to Eclipse at first, hence its complaining. But fear not, as those gaping holes of ignorance will sooner or later be stuffed.

C4DT Running Scenarios

2010-05-03T12:55:23Z

Mortimer: /* Expressions */

==Introduction==
Before continuing you should make sure that you have completed the steps described in [[C4DT_Installation_Guide]].

==Running Scenarios==
[[File:C4DT_Run_Scenario.png|right]] You can run scenarios by selecting it in the Project Explorer and then selecting the option Run Scenario found in the popup menu of the Run button (the green one with the white play symbol). 

==Debugging==
[[File:C4DT_Debug_Persp.PNG|right]] To execute scripts one-instruction-at-a-time and inspect values while the script is halted, you have to switch to the debug perspective first. The layout of the main window changes to acommodate debugging. You can still arrange the views as you want but changes to the layout done while in the debug perspective will stay in the debug perspective, so as soon as you switch back to the Clonk perspective your old layout will be restored.
[[File:C4DT_Breakpoint.PNG|right]] Apart from window layout there are also some keyboard shortcuts that become available. Among those is the shortcut to create a breakpoint. By default, it's Ctrl+Shift+B. You can open any c4script and place a breakpoint in a line that contains function code by using that shortcut (or alternatively right-clicking the ledge on the left and clicking "Toggle Breakpoint"). 
[[File:C4DT_Debug_Button.PNG|right]] To run a scenario in debug mode all you have to do is pressing the Debug button instead of the Run one. The engine will now be halting script execution as soon as it encounters an instruction marked by a breakpoint. Eclipse will highlight the location where script execution halted. Now various views can be utilised to gain information about the current state of variables and objects. More on those views below.
Now that execution is halted you can do three things:
*Step Into: The instruction at the current execution position will be executed. If the instruction contains a function call, the debugger will jump into the function and allow you to continue stepping inside that function. Default keystroke: F5
*Step Over: Same as Step Into with the exception that the debugger won't go into subordinate function calls. Default keystroke: F6
*Resume: Resume script execution. The engine will run normally until the next breakpoint is encountered. Default keystroke: F8


==Variables==
[[File:C4DT_Variables_View.PNG|right]] The Variables view displays local variables and parameters of the function being executed. 

==Expressions==
[[File:C4DT_Expressions_View.PNG]] The expressions view displays a list of user-defined expressions that get evaluated after every execution step. It is evaluated in the context of the calling object so expressions like "GetName()" will work as expected. Local variables and parameters can in principle be used in expressions but evaluation of such expressions might be buggy.
To add new expressions right-click into the view and select "Add Watch Expression".

C4DT Running Scenarios

2010-05-03T12:54:29Z

Mortimer: /* Debugging */

C4DT Running Scenarios

2010-05-03T12:53:35Z

Mortimer: /* Debugging */

==Introduction==
Before continuing you should make sure that you have completed the steps described in [[C4DT_Installation_Guide]].

==Running Scenarios==
[[File:C4DT_Run_Scenario.png|right]] You can run scenarios by selecting it in the Project Explorer and then selecting the option Run Scenario found in the popup menu of the Run button (the green one with the white play symbol). 

==Debugging==
[[File:C4DT_Debug_Persp.PNG|right]] To execute scripts one-instruction-at-a-time and inspect values while the script is halted, you have to switch to the debug perspective first. The layout of the main window changes to acommodate debugging. You can still arrange the views as you want but changes to the layout done while in the debug perspective will stay in the debug perspective, so as soon as you switch back to the Clonk perspective your old layout will be restored.
[[File:C4DT_Breakpoint.PNG|right]] Apart from window layout there are also some keyboard shortcuts that become available. Among those is the shortcut to create a breakpoint. By default, it's Ctrl+Shift+B. You can open any c4script and place a breakpoint in a line that contains function code by using that shortcut (or alternatively right-clicking the ledge on the left and clicking "Toggle Breakpoint"). 
[[File:C4DT_Debug_Button.PNG|right]] To run a scenario in debug mode all you have to do is pressing the Debug button instead of the Run one. The engine will now be halting script execution as soon as it encounters an instruction marked by a breakpoint. Eclipse will highlight the location where script execution halted. Now various views can be utilised to gain information about the current state of variables and objects. More on those views below.
Now that execution is halted you can do three things:
*Step Into: The instruction at the current execution position will be executed. If the instruction contains a function call, the debugger will jump into the function and allow you to continue stepping inside that function.
*Step Over: Same as Step Into with the exception that the debugger won't go into subordinate function calls.
*Resume: Resume script execution. The engine will run normally until the next breakpoint is encountered.


==Variables==
[[File:C4DT_Variables_View.PNG|right]] The Variables view displays local variables and parameters of the function being executed. 

==Expressions==
[[File:C4DT_Expressions_View.PNG]] The expressions view displays a list of user-defined expressions that get evaluated after every execution step. It is evaluated in the context of the calling object so expressions like "GetName()" will work as expected. Local variables and parameters can in principle be used in expressions but evaluation of such expressions might be buggy.

C4DT Running Scenarios

2010-04-29T14:45:13Z

Mortimer:

==Introduction==
Before continuing you should make sure that you have completed the steps described in [[C4DT_Installation_Guide]].

==Running Scenarios==
[[File:C4DT_Run_Scenario.png|right]] You can run scenarios by selecting it in the Project Explorer and then selecting the option Run Scenario found in the popup menu of the Run button (the green one with the white play symbol). 

==Debugging==
[[File:C4DT_Debug_Persp.PNG|right]] To execute scripts one-instruction-at-a-time and inspect values while the script is halted, you have to switch to the debug perspective first. The layout of the main window changes to acommodate debugging. You can still arrange the views as you want but changes to the layout done while in the debug perspective will stay in the debug perspective, so as soon as you switch back to the Clonk perspective your old layout will be restored.
[[File:C4DT_Breakpoint.PNG|right]] Apart from window layout there are also some keyboard shortcuts that become available. Among those is the shortcut to create a breakpoint. By default, it's Ctrl+Shift+B. You can open any c4script and place a breakpoint in a line that contains function code by using that shortcut (or alternatively right-clicking the ledge on the left and clicking "Toggle Breakpoint"). 
[[File:C4DT_Debug_Button.PNG|right]] To run a scenario in debug mode all you have to do is pressing the Debug button instead of the Run one. The engine will now be halting script execution as soon as it encounters an instruction marked by a breakpoint. Eclipse will highlight the location where script execution halted. Now various views can be utilised to gain information about the current state of variables and objects.

==Variables==
[[File:C4DT_Variables_View.PNG|right]] The Variables view displays local variables and parameters of the function being executed. 

==Expressions==
[[File:C4DT_Expressions_View.PNG]] The expressions view displays a list of user-defined expressions that get evaluated after every execution step. It is evaluated in the context of the calling object so expressions like "GetName()" will work as expected. Local variables and parameters can in principle be used in expressions but evaluation of such expressions might be buggy.

C4DT Running Scenarios

2010-04-29T14:44:20Z

Mortimer:

==Introduction==
Before continuing you should make sure that you have completed the steps described in [[C4DT_Installation_Guide]].

==Running Scenarios==
[[File:C4DT_Run_Scenario.png|right]] You can run scenarios by selecting it in the Project Explorer and then selecting the option Run Scenario found in the popup menu of the Run button (the green one with the white play symbol). 

==Debugging==
[[File:C4DT_Debug_Persp.PNG|right]] To execute scripts one-instruction-at-a-time and inspect values while the script is halted, you have to switch to the debug perspective first. The layout of the main window changes to acommodate debugging. You can still arrange the views as you want but changes to the layout done while in the debug perspective will stay in the debug perspective, so as soon as you switch back to the Clonk perspective your old layout will be restored.
[[File:C4DT_Breakpoint.PNG|right]] Apart from window layout there are also some keyboard shortcuts that become available. Among those is the shortcut to create a breakpoint. By default, it's Ctrl+Shift+B. You can open any c4script and place a breakpoint in a line that contains function code by using that shortcut (or alternatively right-clicking the ledge on the left and clicking "Toggle Breakpoint"). 
[[File:C4DT_Debug_Button.PNG|right]] To run a scenario in debug mode all you have to do is pressing the Debug button instead of the Run one. The engine will now be halting script execution as soon as it encounters an instruction marked by a breakpoint. Eclipse will highlight the location where script execution halted. Now various views can be utilised to gain information about the current state of variables and objects.

==Variables==
[[File:C4DT_Variables_View.PNG|right]] The Variables view displays local variables and parameters of the function being executed. 

==Expressions==
[[File:C4DT_Expressions_View.PNG|right]] The expressions view displays a list of user-defined expressions that get evaluated after every execution step. It is evaluated in the context of the calling object so expressions like "GetName()" will work as expected. Local variables and parameters can in principle be used in expressions but evaluation of such expressions might be buggy.

File:C4DT Expressions View.PNG

2010-04-29T14:42:18Z

Mortimer:

File:C4DT Variables View.PNG

2010-04-29T14:34:14Z

Mortimer:

C4DT Running Scenarios

2010-04-29T13:11:22Z

Mortimer:

File:C4DT Debug Button.PNG

2010-04-29T13:06:03Z

Mortimer:

C4DT Running Scenarios

2010-04-29T13:03:24Z

Mortimer:

File:C4DT Run Scenario.png

2010-04-29T13:00:33Z

Mortimer:

C4DT Running Scenarios

2010-04-29T12:57:33Z

Mortimer: Created page with '==Introduction== Before continuing you should make sure that you have completed the steps described in C4DT_Installation_Guide. ==Running Scenarios== ==Debugging== <…'

==Introduction==
Before continuing you should make sure that you have completed the steps described in [[C4DT_Installation_Guide]].

==Running Scenarios==

==Debugging==
[[File:C4DT_Debug_Persp.PNG|right]] To execute scripts one-instruction-at-a-time and inspect values while the script is halted, you have to switch to the debug perspective first. The layout of the main window changes to acommodate debugging. You can still arrange the views as you want but changes to the layout done while in the debug perspective will stay in the debug perspective, so as soon as you switch back to the Clonk perspective your old layout will be restored.
[[File:C4DT_Breakpoint.PNG|right]] Apart from window layout there are also some keyboard shortcuts that become available. Among those is the shortcut to create a breakpoint. By default, it's Ctrl+Shift+B. You can open any c4script and place a breakpoint in a line that contains function code by using that shortcut (or alternatively right-clicking the ledge on the left and clicking "Toggle Breakpoint").

File:C4DT Breakpoint.PNG

2010-04-29T12:54:35Z

Mortimer:

File:C4DT Debug Persp.PNG

2010-04-29T12:46:55Z

Mortimer:

C4DT Editors

2010-04-20T14:07:55Z

Mortimer:

C4DT Editors

2010-04-19T14:36:57Z

Mortimer:

C4DT Editors

2010-04-19T14:32:24Z

Mortimer:

C4DT Editors

2010-04-19T14:31:52Z

Mortimer:

C4DT Editors

2010-04-19T14:31:11Z

Mortimer:

C4DT Editors

2010-04-19T14:27:47Z

Mortimer: Outline + Problems View

File:Eclipse ProblemsView.png

2010-04-19T14:26:32Z

Mortimer:

File:Eclipse Outline.png

2010-04-19T14:19:42Z

Mortimer:

Developing Content with Eclipse

2010-04-19T12:28:26Z

Mortimer:

Developing Content with Eclipse

2010-04-19T12:28:11Z

Mortimer:

== Introduction ==

Eclipse is an extensible opensource IDE written in Java. It can be obtained from [http://eclipse.org/downloads/ here]. For the purpose of Clonk development the ''Eclipse IDE for Java Developers'' package will do. In order for Eclipse to be aware of C4Scripts and other Clonk-related files a plugin has to be installed. An explanation on how to do that can be found in the [[C4DT Installation Guide]]. Below is a list of tutorials to introduce you to C4DT, the Clonk Development Tools for Eclipse.

== Tutorials ==
* [[C4DT Installation Guide|Installation]]
* [[C4DT Editors|Editors]]
* [[C4DT Navigation|Navigation]]
* [[C4DT Running Scenarios|Running Scenarios]]

Developing Content with Eclipse

2010-04-19T12:27:44Z

Mortimer:

== Introduction ==

Eclipse is an extensible opensource IDE written in Java. It can be obtained from [http://eclipse.org/downloads/ here]. For the purpose of Clonk development the ''Eclipse IDE for Java Developers'' package will do. In order for Eclipse to be aware of C4Scripts and other Clonk-related files a plugin has to be installed. An explanation on how to do that can be found in the [[C4DT Installation Guide]]. Below is a list of tutorials to introduce you to C4DT, the Clonk Development Tools for Eclipse.

== Tutorials ==
* [[C4DT Installation Guide|Installation]]
* [[C4DT Editors|Editors]]
* [[C4DT Editing Other Clonk Files|Editing other Clonk files]]
* [[C4DT Navigation|Navigation]]
* [[C4DT Running Scenarios|Running Scenarios]]

C4DT Editing Scripts

2010-04-19T12:27:21Z

Mortimer: moved C4DT Editing Scripts to C4DT Editors: It turned out more generic than intented.

#REDIRECT [[C4DT Editors]]

C4DT Editors

2010-04-19T12:27:21Z

Mortimer: moved C4DT Editing Scripts to C4DT Editors: It turned out more generic than intented.

C4DT Editors

2010-04-19T12:26:15Z

Mortimer:

C4DT Editors

2010-04-19T12:24:26Z

Mortimer: