ktaf/com.github.benpollarduk.ktaf.assets.characters/PlayableCharacter

PlayableCharacter

class PlayableCharacter(val identifier: Identifier, var description: Description, val canConverse: Boolean = true, items: List<Item> = emptyList()) : Character

A playable character with the specified identifier and description and items. If the playable character can converse with a Converser should be set to true, else false.

Constructors

PlayableCharacter

constructor(identifier: String, description: String, canConverse: Boolean = true, items: List<Item> = emptyList())

A playable character with the specified identifier and description and items. If the playable character can converse with a Converser should be set to true, else false.

constructor(identifier: Identifier, description: Description, canConverse: Boolean = true, items: List<Item> = emptyList())

Properties

attributes

open override val attributes: AttributeManager

An AttributeManager that provides management of all Attribute for this Examinable.

canConverse

val canConverse: Boolean = true

commands

open override var commands: List<CustomCommand>

A list of CustomCommand that this Examinable provides.

description

open override var description: Description

A Description that describes this object.

examination

var examination: Examination

Provides a callback for handling examination of this object.

identifier

open override var identifier: Identifier

An Identifier that can be used to identify this object.

interaction

var interaction: Interaction

Specifies how this Character interacts with various Item.

isAlive

var isAlive: Boolean

Determines if this Character is alive.

isPlayerVisible

open override var isPlayerVisible: Boolean

Returns true if visible to the player, else false.

items

val items: List<Item>

This characters Item.

Functions

acquireItem

fun acquireItem(item: Item)

Acquire the specified item.

decquireItem

fun decquireItem(item: Item)

Dequire the specified item.

examine

open override fun examine(scene: ExaminationScene): ExaminationResult

Examine this object to obtain an ExaminationResult. The scene that the examination occurs in must be specified.

findItem

fun findItem(itemName: String, includeInvisibleItems: Boolean = false): Item?

Find an return an item from the specified itemName. When includeInvisibleItems is set to true even Item that have been marked as invisible to the player will be inspected. If the Character does not have the Item then null wil be returned.

give

fun give(item: Item, character: Character): Boolean

Give a specified item to a specified character. This will return true if the transaction was successful, else false.

hasItem

fun hasItem(item: Item, includeInvisibleItems: Boolean = false): Boolean

Determine if this Character has the specified item. When includeInvisibleItems is set to true even Item that have been marked as invisible to the player will be inspected.

interact

open override fun interact(item: Item): InteractionResult

Interact with the specified item to obtain a InteractionResult.

kill

fun kill()

Kill this Character.

toString

open override fun toString(): String

useItem

fun useItem(item: Item, target: InteractWithItem): InteractionResult

Trigger this PlayableCharacter to use the specified item on the specified target.