IdleSol
commented
1 month ago 2. A drug model and an example of its implementation
2.1. A simple drug model. Or the first level of complexity
This model assumes that the drug takes effect immediately after administration.
The maximum concentration of the vitamin occurs at the time of drug consumption. Over time, the concentration decreases to zero. The effect lasts either all the time or up to a certain concentration value. A blood test shows the presence of the drug while the effect is in effect.
This model can be used for all types of drugs that require a syringe to use. For example morphine.
Example. TEST A-MED: Simple A drug that takes effect immediately after use. Time of action is 1 minute.
Since the drug must act immediately after use, the vitamin that has the effect is specified in the use_action section. Its vit_type takes the value drug.
The action time is 1 minute. This is a rather small action time, it is better to choose a precision close to 1 second. Or "rate": "1 s". Then the concentration of the vitamin is equal to 60 second / 1 second = 60 units.
This is enough to describe the drug itself:
{
"id": "test_AMED_simple",
"type": "COMESTIBLE",
"comestible_type": "MED",
"name": { "str_sp": "TEST A-MED: Simple" },
"description": "Abstract medicine: simple",
...
"use_action": {
"type": "consume_drug",
"activation_message": "You take some %s.",
"vitamins": [ [ "vit_AMED_simple", 56 ] ]
}
},Clarification. Why 56 and not 60? Because the time of consumption of the drug affects the duration. And at this concentration, the effect will wear off after 60 seconds. But taking a second dose would only add 56 units. So instead of two minutes, it would be one minute and 56 seconds.
The example specifically sets this concentration. This shows that an accurate calculation is possible, provided that certain conditions are met.
In practice, I would recommend putting exactly as much as you get. That is, 60 units. And do not pay attention to the error. It is all the more noticeable on drugs with a duration of action of less than a minute. For 5 minutes, 4 seconds it is almost imperceptible. Plus it's easier for other people to understand. 60 units of 1 second means it lasts 1 minute.
What can we say about the vitamin?
We know that its concentration can reach 60 units. How many doses taken at the same time will be affected? Let's say two doses. Then the maximum concentration is 120 units.
The presence of the vitamin in the character's body should have an effect. So we need a field to specify the effect identifier: excess. Let's assume that the effect does not depend on the concentration of the vitamin and is always active when the vitamin is present. Then the range of the effect is from 1 to 120 units of the vitamin: "disease_excess": [ [ 1, 120 ] ]
This is generally enough to describe the vitamin:
{
"id": "vit_AMED_simple",
"type": "vitamin",
"vit_type": "drug",
"name": { "str": "A-MED: Simple" },
"excess": "TEST_MESSAGE_AMED_simple",
"min": 0,
"max": 120,
"rate": "1 s",
"disease_excess": [ [ 1, 120 ] ]
},Now we need to describe the effect. In our case, it's quite simple:
{
"type": "effect_type",
"id": "TEST_MESSAGE_AMED_simple",
"name": ["A-MED: Simple"],
"max_intensity": 1,
"rating": "good",
"apply_message": "A-MED: Simple. BEGIN",
"remove_message": "A-MED: Simple. END",
"blood_analysis_description": "A-MED: Simple"
},When the effect begins and ends, the corresponding messages are output to the log. And for blood analysis, the message specified in blood_analysis_description is output.
Because it is a simple model, it scales well with the number of doses taken. Each successive dose increases the concentration of the vitamin, thus prolonging the effect of the drug.
Intensity levels can be added, from taking additional doses:
"disease_excess": [ [ 1, 60 ] , [ 61, 120 ] ]
----
"max_intensity": 2That's two levels of intensity. Where [ 1, 60 ] corresponds to one tablet taken and [ 61, 120 ] to two tablets. The important thing is to remember to change the maximum concentration: "max": 120.
Clarification. If you take a preparation with a vitamin concentration of 1000, but leave the value "max": 120. The character will get only 120 units. But it will be displayed that you have consumed 1000 units in a day.
You can add a threshold beyond which the vitamin has no effect, but continues to display a message for the analyzer. There are two ways to do this.
A more complicated way is to calculate the base values of the effects and their modifications. So that they would not work in a certain range. Or use adding an effect through the deficiency field.
You can see how it works on the example: TEST A-MED: Simple v2. This is the analog of TEST A-MED: Simple. But when the concentration of the vitamin drops to 10 units, the effect is replaced.
{
"id": "vit_AMED_simple_v2",
"type": "vitamin",
"vit_type": "drug",
"name": { "str": "A-MED: Simple v2" },
"deficiency": "TEST_MESSAGE_AMED_simple_v3",
"excess": "TEST_MESSAGE_AMED_simple_v2",
"min": 0,
"max": 120,
"rate": "1 s",
"disease": [ [ 1, 10 ] ],
"disease_excess": [ [ 11, 60 ] ]
}, {
"type": "effect_type",
"id": "TEST_MESSAGE_AMED_simple_v2",
"name": ["A-MED: Simple v2"],
"max_intensity": 1,
"rating": "good",
"apply_message": "A-MED: Simple v2 [ 11, 60 ]. BEGIN",
"remove_message": "A-MED: Simple v2 [ 11, 60 ]. END",
"blood_analysis_description": "A-MED: Simple"
},
{
"type": "effect_type",
"id": "TEST_MESSAGE_AMED_simple_v3",
"name": ["A-MED: Simple v3"],
"max_intensity": 1,
"rating": "good",
"apply_message": "A-MED: Simple v3 [ 1, 10 ]. BEGIN",
"remove_message": "A-MED: Simple v3 [ 1, 10 ]. END",
"blood_analysis_description": "AMED: Simple"
},In the example, two effects have the same text for a blood test. Thus the player will not know that the effect has been replaced, but will know that he still has the corresponding drug in his body.
Maddremor
Hyperseeker
harakka
Useful links:
70239
76905
Contents
The vitamin system and its features 1.1. Method of adding vitamins to a drug 1.2. How to put a vitamin into a character's body 1.3. The lifetime of a single vitamin or how accurately a drug should work 1.4. Using a vitamin to add
effect1.5. A vitamin that decays into another vitamin 1.6. A little abouteffectsA drug model and an example of its implementation 2.1. A simple drug model. Or the first level of complexity link 2.2. Drug model. The second level of complexity link 2.3. Drug model. Third level of complexity link 2.4. Combined drug model. Or fourth level of complexity link 2.5. Exploitation of the features of existing vitamin implementation link
How it could be link
Explanation of the difference between effect and
effect. So that there is no confusion. Effect is just a word, in the standard sense.Effectis an indication that we are talking about a relevant parameter. For example, theeffectof a painkiller has the effects of a painkiller and a sleeping pill.Or:
1. The vitamin system and its features
There are several ways to add vitamins to an item in the game. And vitamins can be of several types. For more details, see topic #76905.
1.1. Method of adding vitamins to a drug
I will use the following method:
Where
some_vitis a vitamin of type:"vit_type": "drug".Because when using
use_action:vit_type.Note. If you use the method:
And set
"vit_type": "counter". The vitamin will enter the character's body between 30:01 and 60:00 minutes. And in the amount of 2 units, not 100 units, as specified in the example. And then every half an hour it will arrive in one more unit. The variation is related to the stomach cycle, which is equal to 30 minutes. The drug is delivered after two stomach cycles:And for
"vit_type": "drug", the drug will arrive in full, but after the current stomach cycle is complete, that is, between 1 second and 30 minutes.1.2. How to put a vitamin into a character's body
The main method is to take a drug that has a vitamin section in the description. It is convenient because you open the json record and you can immediately see what is how much and where. But it is only suitable for simple versions of drugs. By simple versions, I mean drugs that act immediately after use. No delayed actions or different
effects with different durations. There is a vitamin - there iseffect, no vitamin - noeffect.There are additional methods of adding a vitamin:
effect, which can be caused by anything, including the action of other vitamins.In the examples, I will use the decay of vitamins into other vitamins. Because, I just haven't dealt with generating vitamins through
effect. They have their own mechanics and how they interact (or not) with the mechanics of "standard" vitamins, I haven't looked into.1.3. The lifetime of a single vitamin or how accurately a drug should work
A vitamin has a parameter
rate. The documentation says:But the documentation doesn't specify that this doesn't work for the first vitamin ingested. It only works for all other vitamins. If this value is small and the concentration is large, it is hardly noticeable. But:
Here's a vitamin that can disappear (be absorbed) 1 second after ingestion. Or any other random number between 1 second and 24 hours. Because absorption occurs at exactly midnight. And you can take the drug at any time of day.
Clarification. It is assumed that as long as there is a vitamin in the body, a beneficial
effectis in effect. If it is used to generate a new vitamin, then the drug will take effect at a random time between 1 second and 24 hours. Because it will decay at that time into another vitamin that gives the beneficialeffect.Why is that? Because time is split into segments of a long
rate. And the starting point is at 0:00:00 of the 1st day of spring. The standard game starts at 8:00:00 on the 61st day of spring. Or after 5 212 800 moves. For"rate": "24 h",there goes the 61st segment.This is important to remember if you want to make "accurate" drugs.
Recommendation. Select the
ratedimension to a level lower than the required accuracy. If the drug is to take effect for hours, specifyrate= 1 minute. If the effect of the drug lasts for a few minutes? Thenrate= 1 second.And use the concentration to adjust the duration. Then a vitamin with a concentration of 60 and
"rate": "1 m"will act from 59 minutes to 60 minutes. And if"rate": "1 s"then 64 seconds (the time of drug use is 6 seconds, during which 2 units of vitamin are absorbed)1.4. Using a vitamin to add
effectThe game gives us two tools:
deficiencyandexcess. These parameters specify whateffectto apply in case of vitamin deficiency or excess. And the value of thresholds is specified indiseaseanddisease_excess.And for most drugs, only one of them can be used. Either
deficiencyorexcess.Excessis better, since the value of vitamins is a positive number. But not necessarily. (And it doesn't have to be positive, you can set min = -90). It's just more convenient.This is due to the fact that the drug works as long as the vitamin is present. Yes it can have different effects, if you work hard and pick up the initial values and their modifiers from the intensity of the effect (focused on the levels prescribed in
diseaseanddisease_excess), you can add or remove effects. But all of them should be prescribed in oneeffector spread over different vitamins (complex drugs witheffects of different duration, about them later).But if we are talking about fantastic variants or magic variants, you can use the variant from the example above.
So at concentrations of 1 to 30 and 61 to 90, the EFF_2 effect works. And between them EFF_1.
Clarification. You can't exactly use the same thresholds for
deficiencyandexcess. Only thedeficiencyeffect worked for me. But I didn't check the operation with overlapping ranges.1.5. A vitamin that decays into another vitamin
Vitamin
vit_1at the end of its lifetime (defined byrate) decays into 2vit_3vitamins.There is a peculiarity. The last vitamin is not decayed, but simply absorbed. Therefore, to get
vit_3, the concentration ofvit_1must be greater than 1.1.6. A little about
effectsI won't go through the effects in full. I will only focus on what I use in the examples. Namely, sending a message to the logs and displaying the name of the
effectin the character window.Vitamin
some_vithas two ranges 1..30 and 31..60. These are converted into intensity levels of the effectTM_some_vit. The current amount of vitamin determines which intensity level of theeffectis in effect at a given time.So if you take a drug with a vitamin concentration of 60. Then the second level will act, which after some time will decrease to the first level. And after some more time, the concentration will drop to 0 and the effect will disappear. The log will show the following messages:
And if you use an additional vitamin that will decay by some_vit. Then its concentration will smoothly increase from 0 to 60, then smoothly fall from 60 to 0. And the effect will go from 1 level of intensity to 2 then back to 1. The log will show the following messages:
The maximum possible intensity level is specified in
"max_intensity": 2. For the example, it is equal to 2. It may not coincide with the number of ranges in vitamins. This will not cause a game error, but may affect the correct operation of the drug.nameanddesc- name and descriptions, first for level 1, then for level 2 and so on up to max_intensity value. It is possible not to fill and leave empty space or not to specify these parameters. They are responsible for displaying the effect in the character window (@).apply_message- the message when the effect occurs and when switching from a low intensity level to a high one (for example, from 1 to 2).Mixed- responsible for the color of the message.remove_message- message when the effect is finished.decay_messages- message at transition from high to low intensity level (for example, from 2 to 1).Some related problems are indicated #76886
Important: Do not use one effect for different vitamins. #76963
File with examples: test_med.json