Personality Scoring Filters


Filtering is the means by which you can define who is valid Actor for your personality.

The filtering is composed of several stages :

  1. A list of potential sims is chosen using a specified <StandardFilter>
  2. The list is pared down using the given:
    • <AgeGender> fields
    • <RelationshipMinimum> and <RelationshipMaximum> fields
    • <Clan>, <ClanLeader>, and <ClanMember> fields
    • <DisallowRelated> field
    • <Scoring> and <ScoringMinimum> or <ScoringMaximum> fields
  3. Finally the <ThirdPartyFilter> is applied, creating the final list of potential Actors

Note that each of the following fields are usually specified with a prefix. For instance <Scoring> would appear in the coding as <ActorScoring>, <TargetScoring>, or <CandidateScoring> .

For simplicity, all fields are shown without prefixes.

<DisallowRelated>

  • Defines whether the Target is allowed to be closely related to the Actor or not
  • Note, by default romantic scenarios automatically disallow close relations.
  • Valid values are : "True" or "False"

<StandardFilter>

  • Defines the list of potential targets for a given Actor.
  • Valid values are specified in this post : Standard Filter
  • This type of filtering requires an Actor already be selected, so is only useful in <Target> filtering, or scenarios that allow the use of a <Mutual> filter

<StandardFilterIgnoreBusy>

  • Determines whether the mod is allowed to use sims that are currently doing something else
  • This field must be specified whenever the <StandardFilter> is "ExistingEnemy", "ExistingFriend", or "Nemesis"
  • Valid values are : "True" or "False"

<StandardGate>

  • This field must be specified whenever the <StandardFilter> is "ExistingFriend", "ExistingEnemy"
  • When used with "ExistingFriend", this field defines the minimum relationship required
  • When used with "ExistingEnemy", this field defines the maximum relationship required
  • Valid values for this field are defined here : Relationship Gates

<StandardDisallowPartner>

  • Determines whether the Actors partner should be included in the list of Targets
  • This field must be specified whenever the <StandardFilter> is "ExistingFlirt" or "ExistingOrAnyFlirt"
  • Valid values are : "True" or "False"

<AllowAffair>

  • Determines whether Targets partnered with other sims are allowed in the list of potentials
  • This field must be specified whenever the <StandardFilter> is "AnyFlirt" or "ExistingOrAnyFlirt"
  • Valid values are : "True" or "False"

<Scoring>

  • Defines the Scoring table to use against the potential Targets
  • This field must match an existing Scoring element as defined in either your or the base-mod's <Scoring> XML.

<ScoringMaximum>

  • Defines the maximum scoring value required to be considered a potential.
  • This field or the <ScoringMinimum> field must be specified if the <Scoring> field has been given
  • Valid values are any whole number

<ScoringMinimum>

  • Defines the minimum scoring value required to be considered a potential
  • This field or the <ScoringMaximum> field must be specified if the <Scoring> field has been given
  • Valid values are any whole number

<RelationshipMaximum>

  • Defines the maximum relationship value required between the Actor and a potential
  • Valid values for this field are defined here : Relationship Gates

<RelationshipMinimum>

  • Defines the minimum relationship value required between the Actor and a potential
  • Valid values for this field are defined here : Relationship Gates

<Clan>

  • Specifies the unique Name for another town personality
  • For instance, if you wanted a list of all the members of "TownNerd", this field will provide that ability
  • Note that is not necessary to specify your own personality Name if you filtering on your own members
  • Only one clan can be specified using this field. To filter against multiple clans, you will require a <Scoring> table

<ClanLeader>

  • Whether to include the clan leader in the potentials
  • If <Clan> is specified, the leader of that clan is used
  • If <Clan> is empty, the leader of THIS clan is used
  • Valid values are "True" or "False"

<ClanMembers>

  • Whether to include the clan members (not including the leader) in the potentials
  • If <Clan> is specified, the members of that clan are used
  • If <Clan> is empty, the members of THIS clan are used
  • Valid values are "True" or "False"

<AgeGender>

  • Allows for filtering based on Age and Gender
  • Valid values can be any combination of these values : CASAgeGenderFlags

<UserAgeGender?>

  • Specifies the <Name> of an "AgeGenderOption" defined for this personality
  • The "?" in the field name can be any number between 0 and 9
  • Note the XML parser will stop once it reaches an empty index, so start at 0 and work up from there
  • The "AgeGenderOption" MUST be defined previous to this Option in the table

<ThirdPartyFilter>

  • After all scoring is complete, the list of potentials can be converted into a brand new set of potentials using this field
  • Each potential is filtered using this field, and all the results are added to the final list Targets
  • If left empty, the potentials are immediately converted to the final list of Targets without further filtering
  • Valid values are specified in this post : Third Party Filter