mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-02-28 16:39:43 +00:00
Code Issues Releases Wiki Activity

OpenMW-CS tables doc polish

Browse source
This commit is contained in:
Matjaž Lamut 2022-08-13 08:12:22 +00:00 committed by psi29a
parent 5b4e2ab843
commit d67b1e1320
5 changed files with 35 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
docs/source/manuals/openmw-cs/record-types.rst
View file

@ -16,7 +16,7 @@ Activator
object is in is active the script will be run once per frame. object is in is active the script will be run once per frame.
Apparatus Apparatus
This is a tool to make potions. Again there’s an icon for your inventory as This is a tool to make potions. It takes an icon record for the inventory as
well as a weight and a coin value. It also has a *Quality* value attached to well as a weight and a coin value. It also has a *Quality* value attached to
it: the higher the number, the better the effect on your potions will be. it: the higher the number, the better the effect on your potions will be.
The *Apparatus Type* describes if the item is a *Calcinator*, *Retort*, The *Apparatus Type* describes if the item is a *Calcinator*, *Retort*,
@ -24,7 +24,7 @@ Apparatus
Armor Armor
This type of item adds *Enchantment Points* to the mix. Every piece of This type of item adds *Enchantment Points* to the mix. Every piece of
clothing or armor has a "pool" of potential *Magicka* that gets unlocked clothing or armor has a pool of potential *Magicka* that gets unlocked
when the player enchants it. Strong enchantments consume more magicka from when the player enchants it. Strong enchantments consume more magicka from
this pool: the stronger the enchantment, the more *Enchantment Points* each this pool: the stronger the enchantment, the more *Enchantment Points* each
cast will take up. *Health* means the amount of hit points this piece of cast will take up. *Health* means the amount of hit points this piece of
@ -34,7 +34,7 @@ Armor
Book Book
This includes scrolls and notes. For the game to make the distinction This includes scrolls and notes. For the game to make the distinction
between books and scrolls, an extra property, *Scroll*, has been added. between books and scrolls, *Book Type* property is used.
Under the *Skill* column a scroll or book can have an in-game skill listed. Under the *Skill* column a scroll or book can have an in-game skill listed.
Reading this item will raise the player’s level in that specific skill. Reading this item will raise the player’s level in that specific skill.
@ -43,14 +43,14 @@ Clothing
Rather than *Armor Type*, these items have a *Clothing Type*. Rather than *Armor Type*, these items have a *Clothing Type*.
Container Container
This is all the stuff that stores items, from chests to sacks to plants. Its This is all the stuff that stores items, from chests to sacks to plants.
*Capacity* shows how much stuff you can put in the container. You can Its *Capacity* shows how much stuff you can put in the container. You can
compare it to the maximum allowed load a player character can carry. A compare it to the maximum allowed load a player character can carry. A
container, however, will just refuse to take the item in question when it container, however, will just refuse to take the item in question when it
gets "over-encumbered". Organic Containers are containers such as plants. gets "over-encumbered". *Organic Container* are containers such as plants
Containers that respawn are not safe to store stuff in. After a certain and carry alchemical ingredients. Containers that respawn are not safe to
amount of time, they will reset to their default contents, meaning that store your stuff in. After a certain amount of time, they will reset to
everything in them is gone forever. their default contents, meaning that everything in them is gone forever.
Creature Creature
These can be monsters, animals and the like. These can be monsters, animals and the like.
@ -75,7 +75,9 @@ Door
Ingredient Ingredient
Objects required to create potions in an apparatus. Each ingredient can hold Objects required to create potions in an apparatus. Each ingredient can hold
up to four alchemical effects. up to four alchemical effects. In the wild, containers with *Organic Container*
enabled are used to represent plants from which the ingredient can be gathered
and will periodically respawn.
Item Levelled List Item Levelled List
A list of items that can spawn in a container when the player opens it. A list of items that can spawn in a container when the player opens it.

4
docs/source/manuals/openmw-cs/tables-assets.rst
View file

@ -33,11 +33,11 @@ This textkeys file defines the extents of each animation, and relevant in this
case, events and triggers occuring at particular animation frames. case, events and triggers occuring at particular animation frames.
For example, a typical textkey entry intended for a Sound Generator would be For example, a typical textkey entry intended for a Sound Generator would be
named `SoundGen: Left` and be hand placed by an animator whenever the left leg named ``SoundGen: Left`` and be hand placed by an animator whenever the left leg
of the creature touches the ground. In OpenMW-CS, the appropriate Sound of the creature touches the ground. In OpenMW-CS, the appropriate Sound
Generator of an appropriate type would then be connected to the animated creature. Generator of an appropriate type would then be connected to the animated creature.
In this case the type would be `Left Foot`. Once in-game, OpenMW will play the In this case the type would be `Left Foot`. Once in-game, OpenMW will play the
sound whenever its textkeys occurs in the currently playing animation. sound whenever its textkey occurs in the currently playing animation.
Creature Creature
Which creature uses this effect. Which creature uses this effect.

24
docs/source/manuals/openmw-cs/tables-characters.rst
View file

@ -41,7 +41,7 @@ Description
Classes Classes
******* *******
All characters in OpenMW need to be of a certain class. This table list existing All characters in OpenMW need to be of a certain class. This table lists existing
classes and allows you to create, delete or modify them. classes and allows you to create, delete or modify them.
Name Name
@ -126,9 +126,11 @@ Playable
the NPCs can belong to it. the NPCs can belong to it.
Beast Race Beast Race
Use models and animations for humanoids of different proportions and When enabled, characters of this race will use alternative animations to
movement styles. In addition, beast races can't wear closed helmets depict humanoids of different proportions and movement styles. This is done
or boots. by using a different animation file compared to the main one and thus a new
set of animations needs to be created for this to work properly.
In addition, beast races can't wear closed helmets or boots
Male Weight Male Weight
Scaling factor of the default body type. Values above 1.0 will make members Scaling factor of the default body type. Values above 1.0 will make members
@ -167,15 +169,15 @@ Description
Powers Powers
A list of spells that are given to the player. When spells are added by a A list of spells that are given to the player. When spells are added by a
birthsign, they cannot be removed in-game by the player. birthsign, they cannot be removed from the spell list in-game by the player.
Body Parts Body Parts
********** **********
Characters are made from separate parts. Together they form the whole body. Characters are made from separate parts. Together they form the whole body.
Allows customization of the outer look. Includes heads, arms, legs, torso, hand, Allows customization of the character appearance. Includes heads, arms, legs,
armor, pauldrons, chestpiece, helmets, wearables, etc. torso, hand, armor, pauldrons, chestpiece, helmets, wearables, etc.
Topics Topics
@ -193,10 +195,10 @@ Greeting 0 to 9
Persuasion Persuasion
Persuasion entries produce a dialogue response when using persuasion actions on NPCs. Hardcoded. Persuasion entries produce a dialogue response when using persuasion actions on NPCs. Hardcoded.
* Admire, Bribe, Intimidate Taunt Fail - Conversation text that appears when the player fails a persuasion action. * Admire, Bribe, Intimidate Taunt Fail - Text in the dialogue window that the NPC says when the player fails a persuasion action.
* Admire, Bribe, Intimidate Taunt Succeed - Conversation text that appears when the player succeeds a persuasion action. * Admire, Bribe, Intimidate Taunt Succeed - Text in the dialogue window that the NPC says when the player succeeds a persuasion action.
* Info Refusal - Conversation text that appears when the player wishes to talk about a certain topic and the conditions are not met. For example, NPC disposition is too low, the player is not a faction member, etc. * Info Refusal - Text in the dialogue window that the NPC says when the player wishes to talk about a certain topic and the conditions are not met. For example, NPC disposition is too low, the player is not a faction member, etc.
* Service Refusal - Conversation text that appears when the player wishes a service from the NPC but the conditions are not met. * Service Refusal - Text in the dialogue window that the NPC says when the player wishes a service from the NPC but the conditions are not met.
Topic Topic
A keyword in the dialogue window that leads to further dialogue text, A keyword in the dialogue window that leads to further dialogue text,

3
docs/source/manuals/openmw-cs/tables-mechanics.rst
View file

@ -92,7 +92,8 @@ Each enchantment can hold multiple magic effects along with other properties.
Entries can be freely added or removed through the editor. Entries can be freely added or removed through the editor.
Enchantment Type Enchantment Type
The way to use this enchantment. The way this enchantment is triggered.
* Cast once - the enchantment is cast like a regular spell and afterwards the item is gone. Used to make scrolls. * Cast once - the enchantment is cast like a regular spell and afterwards the item is gone. Used to make scrolls.
* Constant effect - the effects of the enchantment will always apply as long as the enchanted item is equiped. * Constant effect - the effects of the enchantment will always apply as long as the enchanted item is equiped.
* When Strikes - the effect will apply to whatever is hit by the weapon with the enchantment. * When Strikes - the effect will apply to whatever is hit by the weapon with the enchantment.

8
docs/source/manuals/openmw-cs/tables-world.rst
View file

@ -235,8 +235,12 @@ Pathgrids
Pathgrids allow NPCs to navigate and move along complicated paths in their surroundings. Pathgrids allow NPCs to navigate and move along complicated paths in their surroundings.
A pathgrid contains a list of *points* connected by *edges*. NPCs will A pathgrid contains a list of *points* connected by *edges*. NPCs will
find their way from one point to another as long as there is a path of find their way from one point to another as long as there is a path of
connecting edges between them. One pathgrid is used per cell. When recast connecting edges between them. One pathgrid is used per cell.
navigation is enabled, the pathgrids are not used.
When recast navigation is enabled pathgrids are still used and complement
navigation meshes. Pathgrids help where original Morrowind content is not
suitable for navigation mesh generation. In addition, the off-mesh connections
generated from pathgrids are important for NPC AiWander package.
Regions Regions