btech.character on StompyMUX Documentation

add_skill_experience

Mon, 01 Jan 0001 00:00:00 +0000

Adds experience to one of a character’s skills.

Function

Synopsis

btech.character.add_skill_experience( character, skill, amount )

Arguments

Object character: The character.
string skill: The skill name.
integer amount: The signed experience adjustment. The character’s current packed experience plus this amount must remain within -2,147,483,648 through 2,147,483,647; exceeding that range is unsupported.

Returns

None.

catalog

Mon, 01 Jan 0001 00:00:00 +0000

Lists configured character values of a given kind.

Function

Synopsis

btech.character.catalog( kind, character )

Arguments

string kind: One of Char_value, Char_skill, Char_advantage, or Char_attribute, matched case-insensitively. An unrecognized kind returns an empty array.
Object|nil character: An optional character used to restrict non-attribute results to values whose current amount or experience is nonzero. Attributes are always retained.

Returns

BtechCharacterValueDefinition[] definitions: The matching value definitions.

experience_threshold

Mon, 01 Jan 0001 00:00:00 +0000

Returns the configured base experience threshold for a skill.

Function

Synopsis

btech.character.experience_threshold( skill )

Arguments

string skill: The skill name.

Returns

integer threshold: The configured base threshold. This is not the character-specific experience remaining until the next level. The experience_to_next_level field returned by btech.character.value is the character’s cumulative target; subtract the returned experience field to calculate the remaining amount.

set_skill_experience

Mon, 01 Jan 0001 00:00:00 +0000

Sets a character skill’s packed experience value.

Function

Synopsis

btech.character.set_skill_experience( character, skill, experience )

Arguments

Object character: The character.
string skill: The skill name.
integer experience: The new packed experience value, from 0 through 2,147,483,647. The value modulo 16,777,216 is the skill’s accumulated experience; each complete multiple of 16,777,216 adds one to the skill’s effective value.

Returns

None.

set_skill_target

Mon, 01 Jan 0001 00:00:00 +0000

Sets a character skill’s target number.

Function

Synopsis

btech.character.set_skill_target( character, skill, target )

Arguments

Object character: The character.
string skill: The skill name.
integer target: A target number representable by a raw skill level from 0 through 255. The reachable target range depends on the character’s base target and current skill modifiers.

Returns

None.

set_value

Mon, 01 Jan 0001 00:00:00 +0000

Sets a script-visible character value.

Function

Synopsis

btech.character.set_value( character, value, amount )

Arguments

Object character: The character.
string value: The value name.
integer amount: The new value, accepted from -2,147,483,648 through 2,147,483,647. Accepted values below 0 are stored as 0, and values above 255 are stored as 255.

Returns

None.

value

Mon, 01 Jan 0001 00:00:00 +0000

Returns one script-visible character value.

Function

Synopsis

btech.character.value( character, value )

Arguments

Object character: The character.
string|integer value: The value name or numeric code.

Returns

BtechCharacterValue result: The definition and current value.

Notes

experience_to_next_level is a cumulative experience target. Subtract the result’s current experience to calculate the experience still required.

btech.character on StompyMUX Documentation

add_skill_experience

Function

Synopsis

Arguments

Returns

See Also

catalog

Function

Synopsis

Arguments

Returns

See Also

experience_threshold

Function

Synopsis

Arguments

Returns

See Also

set_skill_experience

Function

Synopsis

Arguments

Returns

See Also

set_skill_target

Function

Synopsis

Arguments

Returns

See Also

set_value

Function

Synopsis

Arguments

Returns

See Also

value

Function

Synopsis

Arguments

Returns

Notes

See Also