Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update traits contrib readme

Browse source
This commit is contained in:
InspectorCaracal 2024-01-26 15:17:52 -07:00 • committed by GitHub
parent ccd384b0f3
commit a2ae90d1ce
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 26 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

52
evennia/contrib/rpg/traits/README.md
View file

@ -171,7 +171,32 @@ if trait1 > trait2:
``` ```
## Static trait ### Trait
A single value of any type.
This is the 'base' Trait, meant to inherit from if you want to invent
trait-types from scratch (most of the time you'll probably inherit from some of
the more advanced trait-type classes though).
Unlike other Trait-types, the single `.value` property of the base `Trait` can
be editied. The value can hold any data that can be stored in an Attribute. If
it's an integer/float you can do arithmetic with it, but otherwise this acts just
like a glorified Attribute.
```python
> obj.traits.add("mytrait", "My Trait", trait_type="trait", value=30)
> obj.traits.mytrait.value
30
> obj.traits.mytrait.value = "stringvalue"
> obj.traits.mytrait.value
"stringvalue"
```
### Static trait
`value = base + mod` `value = base + mod`
@ -365,31 +390,6 @@ get how filled it is as a percentage etc.
The `.rate` is particularly relevant for gauges - useful for everything The `.rate` is particularly relevant for gauges - useful for everything
from poison slowly draining your health, to resting gradually increasing it. from poison slowly draining your health, to resting gradually increasing it.
### Trait
A single value of any type.
This is the 'base' Trait, meant to inherit from if you want to invent
trait-types from scratch (most of the time you'll probably inherit from some of
the more advanced trait-type classes though).
Unlike other Trait-types, the single `.value` property of the base `Trait` can
be editied. The value can hold any data that can be stored in an Attribute. If
it's an integer/float you can do arithmetic with it, but otherwise this acts just
like a glorified Attribute.
```python
> obj.traits.add("mytrait", "My Trait", trait_type="trait", value=30)
> obj.traits.mytrait.value
30
> obj.traits.mytrait.value = "stringvalue"
> obj.traits.mytrait.value
"stringvalue"
```
## Expanding with your own Traits ## Expanding with your own Traits
A Trait is a class inhering from `evennia.contrib.rpg.traits.Trait` (or from one of A Trait is a class inhering from `evennia.contrib.rpg.traits.Trait` (or from one of