C# Класс object_base, UnderworldExporter

Base class for objects and npcs Works hand in hand with ObjectInteraction
Наследование: UWEBase
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
ItemDesc string
PickAvail bool
PickableDesc string
PickupLink string
TalkAvail bool
UseAvail bool
UseObjectOnDesc string
UseableDesc string

Открытые методы

Метод Описание
Activate ( ) : bool

For when this object is activated by code. Eg buttons

ActivateByObject ( GameObject ObjectUsed ) : bool

Activation of this object by another. EG key on door

AliasItemId ( ) : int

Another item Id this object could potentially have. Eg coin/gold coin. By default it's normal item_id is returned

ApplyAttack ( int damage ) : bool

Object is attacked or damaged in some way.

ApplyAttack ( int damage, GameObject source ) : bool

Applies the attack from a known source

BecomeObjectInHand ( ) : void

This object becomes the object in hand in order to be use

ChangeType ( int newID, int itemType ) : bool

Changes the type of the object. Eg when destroyed and it needs to become debris.

ContextMenuDesc ( int item_id ) : string
ContextMenuUseObjectOn_Inv ( ) : string
ContextMenuUseObjectOn_World ( ) : string
ContextMenuUsedDesc ( ) : string
ContextMenuUsedPickup ( ) : string
CopyObject_base ( GameObject target ) : void

Copies the object base.

Eat ( ) : bool

Player tries to eat this object.

EquipEvent ( int slotNo ) : bool

PLayer puts the object on in an inventory slot.

ExamineVerb ( ) : string
FailMessage ( ) : bool

Failure message to display when this object is used on a another object that has no use for it. Eg a key on a sign.

GetContextMenuText ( int item_id, bool isUseable, bool isPickable, bool ObjectInHand ) : string

Gets the context menu text.

GetImpactPoint ( ) : Vector3
GetWeight ( ) : float

Return the weight of the object stack

LookAt ( ) : bool

Outputs the look description of the object

MergeEvent ( ) : void

Code to call when merging two objects. To support cases where merging an object means the object becomes something different. Eg coin into stack of coins

PickupEvent ( ) : bool

For special events when an object is picked up. Eg silver seed or pickup traps

PickupVerb ( ) : string
PutItemAwayEvent ( int slotNo ) : bool

Event when Item is put into inventory

Split ( ) : void

Code to call when spliting an item and the split changes the item fundamentally.

TalkTo ( ) : bool

Player talks to the object.

UnEquipEvent ( int slotNo ) : bool

Player takes an object out of an inventory slot.

UseObjectOnVerb_Inv ( ) : string
UseObjectOnVerb_World ( ) : string
UseVerb ( ) : string
getEquipString ( ) : string

Gets the sprite name that is displayed when the object is equipped in inventory

getIdentificationLevels ( int EffectID ) : int

Gets the identification Skill levels required for identifying the enchantment..

objInt ( ) : ObjectInteraction,

Gets the object interaction that this object base works with

use ( ) : bool

The object is used by the player.

Защищенные методы

Метод Описание
Start ( ) : void

Описание методов

Activate() публичный Метод

For when this object is activated by code. Eg buttons
public Activate ( ) : bool
Результат bool

ActivateByObject() публичный Метод

Activation of this object by another. EG key on door
public ActivateByObject ( GameObject ObjectUsed ) : bool
ObjectUsed GameObject Object used.
Результат bool

AliasItemId() публичный Метод

Another item Id this object could potentially have. Eg coin/gold coin. By default it's normal item_id is returned
public AliasItemId ( ) : int
Результат int

ApplyAttack() публичный Метод

Object is attacked or damaged in some way.
public ApplyAttack ( int damage ) : bool
damage int Damage.
Результат bool

ApplyAttack() публичный Метод

Applies the attack from a known source
public ApplyAttack ( int damage, GameObject source ) : bool
damage int Damage.
source GameObject Source.
Результат bool

BecomeObjectInHand() публичный Метод

This object becomes the object in hand in order to be use
public BecomeObjectInHand ( ) : void
Результат void

ChangeType() публичный Метод

Changes the type of the object. Eg when destroyed and it needs to become debris.
public ChangeType ( int newID, int itemType ) : bool
newID int New ID.
itemType int Item type.
Результат bool

ContextMenuDesc() публичный Метод

public ContextMenuDesc ( int item_id ) : string
item_id int
Результат string

ContextMenuUseObjectOn_Inv() публичный Метод

public ContextMenuUseObjectOn_Inv ( ) : string
Результат string

ContextMenuUseObjectOn_World() публичный Метод

public ContextMenuUseObjectOn_World ( ) : string
Результат string

ContextMenuUsedDesc() публичный Метод

public ContextMenuUsedDesc ( ) : string
Результат string

ContextMenuUsedPickup() публичный Метод

public ContextMenuUsedPickup ( ) : string
Результат string

CopyObject_base() публичный Метод

Copies the object base.
public CopyObject_base ( GameObject target ) : void
target GameObject Target.
Результат void

Eat() публичный Метод

Player tries to eat this object.
public Eat ( ) : bool
Результат bool

EquipEvent() публичный Метод

PLayer puts the object on in an inventory slot.
public EquipEvent ( int slotNo ) : bool
slotNo int Slot no.
Результат bool

ExamineVerb() публичный Метод

public ExamineVerb ( ) : string
Результат string

FailMessage() публичный Метод

Failure message to display when this object is used on a another object that has no use for it. Eg a key on a sign.
public FailMessage ( ) : bool
Результат bool

GetContextMenuText() публичный Метод

Gets the context menu text.
public GetContextMenuText ( int item_id, bool isUseable, bool isPickable, bool ObjectInHand ) : string
item_id int
isUseable bool
isPickable bool
ObjectInHand bool
Результат string

GetImpactPoint() публичный Метод

public GetImpactPoint ( ) : Vector3
Результат Vector3

GetWeight() публичный Метод

Return the weight of the object stack
public GetWeight ( ) : float
Результат float

LookAt() публичный Метод

Outputs the look description of the object
public LookAt ( ) : bool
Результат bool

MergeEvent() публичный Метод

Code to call when merging two objects. To support cases where merging an object means the object becomes something different. Eg coin into stack of coins
public MergeEvent ( ) : void
Результат void

PickupEvent() публичный Метод

For special events when an object is picked up. Eg silver seed or pickup traps
public PickupEvent ( ) : bool
Результат bool

PickupVerb() публичный Метод

public PickupVerb ( ) : string
Результат string

PutItemAwayEvent() публичный Метод

Event when Item is put into inventory
public PutItemAwayEvent ( int slotNo ) : bool
slotNo int Slot no.
Результат bool

Split() публичный Метод

Code to call when spliting an item and the split changes the item fundamentally.
public Split ( ) : void
Результат void

Start() защищенный Метод

protected Start ( ) : void
Результат void

TalkTo() публичный Метод

Player talks to the object.
public TalkTo ( ) : bool
Результат bool

UnEquipEvent() публичный Метод

Player takes an object out of an inventory slot.
public UnEquipEvent ( int slotNo ) : bool
slotNo int Slot no.
Результат bool

UseObjectOnVerb_Inv() публичный Метод

public UseObjectOnVerb_Inv ( ) : string
Результат string

UseObjectOnVerb_World() публичный Метод

public UseObjectOnVerb_World ( ) : string
Результат string

UseVerb() публичный Метод

public UseVerb ( ) : string
Результат string

getEquipString() публичный Метод

Gets the sprite name that is displayed when the object is equipped in inventory
public getEquipString ( ) : string
Результат string

getIdentificationLevels() публичный Метод

Gets the identification Skill levels required for identifying the enchantment..
public getIdentificationLevels ( int EffectID ) : int
EffectID int Effect ID to test
Результат int

objInt() публичный Метод

Gets the object interaction that this object base works with
public objInt ( ) : ObjectInteraction,
Результат ObjectInteraction,

use() публичный Метод

The object is used by the player.
public use ( ) : bool
Результат bool

Описание свойств

ItemDesc публичное статическое свойство

public static string ItemDesc
Результат string

PickAvail публичное статическое свойство

public static bool PickAvail
Результат bool

PickableDesc публичное статическое свойство

public static string PickableDesc
Результат string

PickupLink публичное свойство

public string PickupLink
Результат string

TalkAvail публичное статическое свойство

public static bool TalkAvail
Результат bool

UseAvail публичное статическое свойство

public static bool UseAvail
Результат bool

UseObjectOnDesc публичное статическое свойство

public static string UseObjectOnDesc
Результат string

UseableDesc публичное статическое свойство

public static string UseableDesc
Результат string