Mercurial > fife-parpg

annotate tools/editor/lang/help_object_edit.txt @ 599:a2024b994ca3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
- re-arranged the ObjectEdit gui to avoid misunderstandings; - the object section groups everything which allows to edit the object file - the instance section only shows instance id and rotation - added help button to plugin - added plugin help text to lang/
author chewie@33b003aa-7bff-0310-803a-e67f0ece8222
date Fri, 27 Aug 2010 12:59:50 +0000
parents
children
rev   line source
599
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
1 Usage:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
2 ------
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
3
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
4 Activate the plugin and select an instance. The selected
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
5 instance will be highlighted, the plugin is set to
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
6 visible or is updated accordingly.
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
7
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
8 MOUSEWHEEL:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
9 - above the offset labels, it allows quick de-/
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
10 increasing of values
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
11 - above dropdowns, it allows to change to the
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
12 next entry (and apply it, e.g. animation viewer
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
13 seamlessly plays the next selected animation)
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
14
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
15 Object editing:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
16 By selecting a rotation, you can alter the offset of
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
17 _this_ angle and save it to the object file. The
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
18 selected instance is just an interface to see your
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
19 changes - you can't change a single instances offset.
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
20
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
21 Instance editing:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
22 Instances can't be edited - you can only type in an id
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
23 which is set if it is unique. Saving your map also saves
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
24 this id to your mapfile.
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
25
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
26 Animation editing:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
27 ATM it is not possible to alter animations. You can
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
28 use the animation viewer to check your defined actions
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
29 though.
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
30
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
31 Buttons:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
32 - p = "Play"
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
33 - S = "Start"
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
34 - E = "End"
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
35 - l1 = "one frame left"
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
36 - r1 = "one frame right
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
37
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
38 User interface:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
39 ---------------
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
40
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
41 The object section allows you to inspect:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
42 - namespace of the object
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
43 - object id
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
44 - blocking flag
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
45 - static flag
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
46 - current x/y offset
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
47
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
48 The instance section shows:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
49 - instance id
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
50 - instance rotation
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
51
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
52 The animation viewer shows:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
53 - nothing, if a static instance is clicked
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
54 - all actions of an instance
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
55 - a control panel to play the animations
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
56
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
57 The purpose of this plugin is to:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
58
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
59 - edit object xml files
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
60 - edit the instance id of the selected instance
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
61 - provide an animation viewer
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
62
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
63 The main purpose is to easily change offsets and
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
64 save these changes. (extremely helpful for the
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
65 creation of tiled walls)
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
66
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
67 Limitations:
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
68 ------------
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
69
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
70 - only object data is saved
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
71 - instances on the map are _not_ touched
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
72 - exception is the instance id, this can be
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
73 altered via this plugin
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
74 - animations can't be edited and / or saved
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
75
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
76 About
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
77 -----
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
78
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
79 The Object Edit plugin was originally written
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
80 by the Zero-Projekt team and was contributed to
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
81 FIFE as an example for the editor plugin system
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
82 and to encourage other projects within the FIFE
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
83 community to also contribute their tools to
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
84 enhance the Editor for all projects
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
85
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
86 cheers,
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
87 chewie
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
88 Zero-Projekt team
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
89
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
90 http://en.zero-projekt.net
a2024b994ca3 - re-arranged the ObjectEdit gui to avoid misunderstandings;
chewie@33b003aa-7bff-0310-803a-e67f0ece8222
parents:
diff changeset
91 http://fifengine.net