Skip to main content

Property

Properties represent the aspects of a character (or companion) that you want to check or modify.

action_selected_options: Property

The array of currently selected options among all Actions.


all_skills: Property

A property representing all skills. This can be useful for things like bonuses to initiative rolls.


ancestry_feat_selection: Property

All ancestry feat selections.


ancestry_feats: Property

An array of all selected ancestry feats.


ancestry_feats_selected_options: Property

An array of all selected options for all selected ancestry feats.


armor_class: Property

The character's or companion's AC.


attribute_modifier(attribute: Attribute): Property

The modifier of the provided attribute.


class_dc_proficiency: Property

The character's proficiency in their class DC.


class_feat_selection: Property

All class feat selections.


class_feats: Property

An array of all selected class feats.


class_feats_selected_options: Property

An array of all selected options for all selected class feats.


class_feature_selected_options: Property

An array of all selected options for all class features.


class_key_attribute: Property

The key attribute for the character's class.


class_spell_attack_proficiency: Property

The character's proficiency in their class' spell attack.


class_spell_dc_proficiency: Property

The character's proficiency in their class' spell DC.


class_spell_selection: Property

All class spell selections.


class_spell_slot(rank: Number): Property

Class spell slots for the given rank.


class_spellcasting_attribute: Property

The spellcasting attribute for the character's class spells.


class_spellcasting_tradition: Property

The magical tradition of the character's class spells.


class_spells: Property

An array of all class spells.


encumbered_bulk: Property

The amount of bulk that can be carried before becoming Encumbered.


equipment_ac_bonus(filter: EquipmentFilter): Property

The AC bonus for the equipment the matches the provided filter.


equipment_attack_bonus(filter: EquipmentFilter): Property

The attack bonus for the equipment the matches the provided filter.


equipment_critical_specialization(filter: EquipmentFilter): Property

Whether or not the character has critical specialization for the equipment the matches the provided filter.


equipment_damage_attribute(filter: EquipmentFilter): Property

The attribute used to calculate the damage bonus for the equipment the matches the provided filter.


equipment_damage_bonus(filter: EquipmentFilter): Property

The damage bonus for the equipment the matches the provided filter.


equipment_damage_dice_count(filter: EquipmentFilter): Property

The number of damage dice for the equipment the matches the provided filter.


equipment_damage_dice_side(filter: EquipmentFilter): Property

The number of sides (aka the size) of the damage dice for the equipment the matches the provided filter.


equipment_damage_type(filter: EquipmentFilter): Property

The damage type for the equipment the matches the provided filter.


equipment_group(filter: EquipmentFilter): Property

The armor or weapon group of the equipment the matches the provided filter.


equipment_hardness(filter: EquipmentFilter): Property

The hardness of the equipment the matches the provided filter.


equipment_hp(filter: EquipmentFilter): Property

The hit points of the equipment the matches the provided filter.


equipment_proficiency(filter: EquipmentFilter): Property

The character's proficiency in the equipment the matches the provided filter.


equipment_range(filter: EquipmentFilter): Property

The weapon range of the equipment the matches the provided filter.


equipment_traits(filter: EquipmentFilter): Property

The traits of the equipment the matches the provided filter.


equipment_upgrade_slots(filter: EquipmentFilter): Property

The number of upgrade slots for the equipment the matches the provided filter.


general_feat_selection: Property

All general and skill feat selections.


general_feats: Property

An array of all selected general and skill feats.


heritage: Property

The ID of the selected heritage.


hit_point_max: Property

The character's or companion's maximum hit points.


immunity: Property

The array of a character's or companion's immunities


innate_spells: Property

A character's innate spells.


language_selection: Property

The number of languages a character knows.


level: Property

The character's or companion's level


maximum_bulk: Property

The maximum bulk that can be carried.


resistance_value(resistance: Resistance): Property

The resistance value for the resistance type provided.


save_dc(save: Save): Property

The DC of the provided skill.


save_modifier(save: Save): Property

The modifier of the provided saving throw.


save_proficiency(save: Save): Property

The character's proficiency in the provided saving throw.


senses: Property

A character's senses.


size: Property

The size of the character.


skill_attribute(skill: Skill): Property

The attributed used for the provided skill.


skill_dc(skill: Skill): Property

The DC of the provided skill.


skill_increase(proficiency: Proficiency): Property

A skill increase with the maximum proficiency that it can update a skill to. For example, bonus(1, skill_increase(expert), untyped) provides one skill increase that can be used to take a skill from untrained to trained, or trained to expert.


skill_modifier(skill: Skill): Property

The modifier of the provided skill.


skill_proficiency(skill: Skill): Property

The character's proficiency in the provided skill.


skill_proficiency_bonus(proficiency: Proficiency): Property

The bonus provided to all skills of the provided proficiency. For example, Untrained Improvisation feat uses this property to provide a bonus to all untrained skills.


speed_value(movement: Movement): Property

The numerical speed for the movement type provided.


weakness_value(weakness: Weakness): Property

The weakness value for the resistance type provided.