Difference between revisions of "Interaction Tuning Resource"
From SimsWiki
ColonolNutty (Talk | contribs) |
ColonolNutty (Talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | + | {{WorkInProgress}} | |
| + | |||
| + | The fields defined in an interaction tuning resource | ||
| + | <p>This table is a list of all possible fields found in an interaction tuning resource.</p> | ||
| + | {|class="wikitable sortable" | ||
| + | ! style="background:#ccf;" | Field Name | ||
| + | ! style="background:#ccf;" | Field Type | ||
| + | ! style="background:#ccf;" | Description | ||
| + | |- | ||
| + | | _saveable || enabled, disabled || Unknown Purpose | ||
| + | |- | ||
| + | | outcome || single, test_based || Instructions on what to do after an interaction succeeds or fails | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | ==Header Example:== | ||
| + | |||
| + | ===<code>Resource Header''(class(c), itemType(i), module(m), stringId(s))''</code>=== | ||
| + | <code><pre><I c="ImmediateSuperInteraction" i="interaction" m="interactions.base.immediate_interaction" n="ExampleSuperInteractionOne" s="12345"></pre></code> | ||
| + | |||
| + | {|class="wikitable" | ||
| + | ! style="background:#ccf;" | Property Name | ||
| + | ! style="background:#ccf;" | Description | ||
| + | |- | ||
| + | | class(c) || The python class that will run the interaction | ||
| + | |- | ||
| + | | itemType(i) || The resource type, in this case ''interaction'' meaning it is an Interaction Tuning Resource | ||
| + | |- | ||
| + | | module(m) || The python namespace to the class | ||
| + | |- | ||
| + | | stringId(s) || The tuning resource identifier, for usage within python. It should be the resource Key in decimal notation. | ||
| + | |- | ||
| + | |} | ||
| + | |||
| + | ==Field Examples:== | ||
| + | |||
| + | NOTE: All elements below have both ''type(t)'' and ''name(n)''. Name must match the python name (without the "_" portion in the name) | ||
| + | |||
| + | ===<code>_saveable(''type(t), name(n)'')</code>=== | ||
| + | ====enabled==== | ||
| + | <code> | ||
| + | <V t="enabled" n="_saveable"> | ||
| + | <Unknown Code> | ||
| + | </V> | ||
| + | </code> | ||
| + | ====disabled==== | ||
| + | <code> | ||
| + | <V t="disabled" n="_saveable" /> | ||
| + | </code> | ||
| + | |||
| + | ===<code>outcome</code>=== | ||
| + | ====single==== | ||
| + | <code> | ||
| + | <pre> | ||
| + | <V t="single" n="outcome"> | ||
| + | <U n="single"> | ||
| + | <U n="actions"> <!-- List of actions to perform on sims --> | ||
| + | <L n="continuation"> | ||
| + | <U> | ||
| + | <T n="affordance">10451411205084654091</T> <!-- The Decimal Identifier of the interaction to push in the queue of this sim --> | ||
| + | <T n="si_affordance_override">9553480838726705593</T> <!-- The Decimal Identifier of the Super Interaction to make this interaction a sub of --> | ||
| + | <!-- If the interaction is between two Teen/YA/Adult/Elder sims use sim_chat) --> | ||
| + | sims/pets)--> | ||
| + | <!-- If the super interaction has the field "visible" set to "false" this interaction | ||
| + | will interaction will be invisible --> | ||
| + | <E n="target">TargetSim</E> <!-- The target of this outcome (Actor/TargetSim) --> | ||
| + | </U> | ||
| + | <U> | ||
| + | <T n="affordance">10451411205084654091</T> | ||
| + | <T n="si_affordance_override">9553480838726705593</T> | ||
| + | <E n="target">Actor</E> | ||
| + | </U> | ||
| + | </L> | ||
| + | <T n="force_outcome_on_exit">True</T> <!-- If True, one of the above outcomes WILL be picked when the interaction ends --> | ||
| + | </U> | ||
| + | </U> | ||
| + | </V> | ||
| + | </pre> | ||
| + | </code> | ||
| + | |||
| + | |||
{{TS4PR_Tuning_Resources_By_Name}} | {{TS4PR_Tuning_Resources_By_Name}} | ||
[[Category:TS4PR]] | [[Category:TS4PR]] | ||
Revision as of 19:15, 15 September 2018
The fields defined in an interaction tuning resource
This table is a list of all possible fields found in an interaction tuning resource.
| Field Name | Field Type | Description |
|---|---|---|
| _saveable | enabled, disabled | Unknown Purpose |
| outcome | single, test_based | Instructions on what to do after an interaction succeeds or fails |
Contents |
Header Example:
Resource Header(class(c), itemType(i), module(m), stringId(s))
<I c="ImmediateSuperInteraction" i="interaction" m="interactions.base.immediate_interaction" n="ExampleSuperInteractionOne" s="12345">
| Property Name | Description |
|---|---|
| class(c) | The python class that will run the interaction |
| itemType(i) | The resource type, in this case interaction meaning it is an Interaction Tuning Resource |
| module(m) | The python namespace to the class |
| stringId(s) | The tuning resource identifier, for usage within python. It should be the resource Key in decimal notation. |
Field Examples:
NOTE: All elements below have both type(t) and name(n). Name must match the python name (without the "_" portion in the name)
_saveable(type(t), name(n))
enabled
<V t="enabled" n="_saveable"> <Unknown Code> </V>
disabled
<V t="disabled" n="_saveable" />
outcome
single
<V t="single" n="outcome">
<U n="single">
<U n="actions"> <!-- List of actions to perform on sims -->
<L n="continuation">
<U>
<T n="affordance">10451411205084654091</T> <!-- The Decimal Identifier of the interaction to push in the queue of this sim -->
<T n="si_affordance_override">9553480838726705593</T> <!-- The Decimal Identifier of the Super Interaction to make this interaction a sub of -->
<!-- If the interaction is between two Teen/YA/Adult/Elder sims use sim_chat) -->
sims/pets)-->
<!-- If the super interaction has the field "visible" set to "false" this interaction
will interaction will be invisible -->
<E n="target">TargetSim</E> <!-- The target of this outcome (Actor/TargetSim) -->
</U>
<U>
<T n="affordance">10451411205084654091</T>
<T n="si_affordance_override">9553480838726705593</T>
<E n="target">Actor</E>
</U>
</L>
<T n="force_outcome_on_exit">True</T> <!-- If True, one of the above outcomes WILL be picked when the interaction ends -->
</U>
</U>
</V>
| TS4PR Tuning Resources by Name | |
|---|---|
