Stendhal code design: Difference between revisions

From Arianne
Jump to navigation Jump to search
← Older edit
Content deleted Content added
imported>Durkham
No edit summary
imported>Hendrik Brummermann
No edit summary
 
(132 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Stendhal code design}}{{Navigation for Stendhal Top|Developing}}__NOTOC__
== Client ==
This page gives a little overview about the Stendhal code.


== Development Environment ==
=== GUI ===


Stendhal is completely open source. So you can [http://arianne.sourceforge.net/download/stendhal-src.tar.gz download the source code] and have a look. If you plan to modify it and contribute to the project, we suggest that you use the Eclipse IDE and checkout the latest development state from our version control system.
If we want to stay with the First screen and all those popup windows or if we want to find a way to integrate it into one is still to be decided.


There are good [[Configure a development environment (IDE)|tutorials]] to get you started with Eclipse.
We would then have one Gui for Login and one for inGame.


== Finding your way around the Code ==
We have already agreed to achieve a InGameGUI like this:


The next step is to find your way around the code. The Stendhal code base is roughly divided into the server, client and a little code that is used by both:
http://img530.imageshack.us/img530/2669/ingamguijp0.png


* [[Finding your way around the Stendhal Server Code]]
* ground is where the game happens
* [[Finding your way around the Stendhal Client Code]]
* chatwindow contains chat, but could also contain a tabbed window so we could divide chat and support maybe an own guild chatwindow.
* [[Finding your way around the Stendhal Web Client Code]] (early development)
* Settings contains minimap , bag i.e. all those windows that now scatter the ground window.


to be continued....




=== Base Client ===

The base client ([ideally] free of any specific UI) is '''StendhalClient'''. It is responsible for interacting with the server, maintaining private user information/state, and dispatching object events.


=== Entities ===

Entities are created using '''EntityFactory.createEntity()'''. In this method, the appropriate implementation class is created, and initialized.

'''Example:'''

RPObject object = ...
Entity entity = EntityFactory.createEntity(object);
// Force the view to be created
entity.getView();
⚫
...
// Done with entity - free up resources
entity.release();


The design is being changed to a Model-View-Controller (MVC) like framework. This will allow different visual implementations (like 2D, 3D, 4D?) to be plugged in with minimal (or no) changes of the model class.


'''Model/Controller'''

This contains all logical entity data, and is responsible for tracking all entity specific attribute changes in the RPObject that it wraps. Currently this also handles some of the UI controller functions.

The '''initialize()''' method is called with the RPObject that it will represent. This method is called after the constructor returns, but before anything else is [externally] called.
When the client no longer needs the entity, it should call '''release()''', which should handle any cleanup, where garbage collection only would be insufficient.

The class gets notified of object changes via the '''RPObjectChangeListener''' interface that it implements. This will be called for all changes to its object (and immediate slot objects).

Methods

* getArea()

This returns the "ground" area that the entity occupies, as it is in the server (with real-time motion adjustments made by the client).

* update(delta)

This is called periodically so that the entity can update any active state. It is passed the number of milliseconds since the last call.


'''View'''

The current view implementation is Entity2DView. This is responsible for rendering an entity in a 2D view.

=== Sound System ===

''TBW''...

=== UI ===

The user interface (UI) is responsible for bringing together the base client and user interaction. The base class is '''StendhalUI''', and is extended by an appropriate implementation (currently j2DClient).


----

== Server ==




== Coding Standards ==
== Coding Standards ==


we try to follow [http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html sun java code convention].
We try to follow [http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html SUN Java code convention], in order to create code that feels familiar to many developers.


Despite this:
Despite this:


* We use tab for all indentation.
* We use tab for all indentation. (One tab is equivalent to 4 spaces for display purpose.)
* We do not stick too closely to line length.
* We do not stick too closely to line length.


* We always use blocks in if-statements and loops, even if the block only consists of one single statement:
* We always use blocks in if-statements and loops, even if the block only consists of one single statement:
<code>
if (condition) {
if (condition) {
method();
method();
}
}
</code>

Avoid evaluation and assignment in the same line like:

* ternary operators, for example in:
<code>String y = x==null ? "NULL": x.toString();</code>

* post-increment/decrement operators as in:
if (idx++ == 10) {
⚫
...
}

Latest revision as of 20:38, 7 September 2015

Stendhal code design


This page gives a little overview about the Stendhal code.

Development Environment

Stendhal is completely open source. So you can download the source code and have a look. If you plan to modify it and contribute to the project, we suggest that you use the Eclipse IDE and checkout the latest development state from our version control system.

There are good tutorials to get you started with Eclipse.

Finding your way around the Code

The next step is to find your way around the code. The Stendhal code base is roughly divided into the server, client and a little code that is used by both:


Coding Standards

We try to follow SUN Java code convention, in order to create code that feels familiar to many developers.

Despite this:

  • We use tab for all indentation. (One tab is equivalent to 4 spaces for display purpose.)
  • We do not stick too closely to line length.
  • We always use blocks in if-statements and loops, even if the block only consists of one single statement:

if (condition) {
    method();
}

Avoid evaluation and assignment in the same line like:

  • ternary operators, for example in:
 String y = x==null ? "NULL": x.toString();
  • post-increment/decrement operators as in:
 if (idx++ == 10) {
   ...
 }
Retrieved from "https://meet.konsthol.eu/w/index.php?title=Stendhal_code_design&oldid=111719"