[ACS] UseInventoryItem()

[Kate]

I'm not sure on the state of the inventory system as to whether this is possible or not, so I'm sure there's a 50/50 chance of this getting marked with [Can't be done].

Code: Select all

int UseInventoryItem (str ClassName)

If the player has an item of this type in their inventory, the function attempts to use it.

If the item was successfully used, the function returns 1 (TRUE), otherwise if the player doesn't have this type of item or it was not used because of some other condition, it returns 0 (FALSE).

Or if it isn't possible to get the state of the item's usage, then having it's return be void would be fine since one could simply check the amounts before and after to see of it decreased by one.

When scripting my inventory system, I noticed a function like this was completely lacking, despite there being a check, take, give, and clear.

[Graf Zahl]

Shouldn't be a problem to add this.

[Kate]

Heh, thanks bunches. =)

[DoomRater]

Hey, monsters that can use inventory items, possibly?

[Matt]

...combined with custom inventory use states, this means we can call just about any instantaneous DECORATE function in ACS...


EDIT: But then again I could just do this

[Matt]

Bump.

Just wondering about the status of this.

[Karate Chris]

I have this working just as you've specified except I've named it 'UseInventory'. Let's hope my second attempt at an ACS command will go well.

[Graf Zahl]

Ok, but needs some changes. The return value should signify actual success of the use, not whether the user had the item. Also, an UseActorInventory function would be a good addition (like GiveInventory/GiveActorInventory.)
I'm not adding it right now because I'm working on some other code so if you want you can make the changes yourself

[Karate Chris]

Returning the success should be easy but I'm not sure how UseActorInventory should return because some actors may use the inventory item successfully and others may not. How would you suggest this should work?

[DoomRater]

I imagine number of actors that used it successfully. There should be similar functions in the code to look at if that's not the case (ACS that changes the actor's state, for example)

[Graf Zahl]

That sounds like a good idea. I would have said to return true if one actor used it successfully but this is definitely more useful.

[Karate Chris]

This should do the trick.

int UseInventory (str ClassName);

This returns 1 if the item has been used successfully, else it returns false.

int UseActorInventory (int TID, str ClassName);

This returns the number of successful times the item has been used.

[Graf Zahl]

Added. But I had to dump all your code and rewrite it based on Take(Actor)Inventory. There were several problems:

1. You didn't clean up the stack.
2. UseActorInventory(0, "Item") did not behave equivalent to the other inventory functions (i.e. affect all players)
3. UseInventory only pushed a return value when the item was valid

[Karate Chris]

Oh well, I suppose I'll get an ACS command working right eventually.

[Pinky's ass]

Useful! Good work!