AAK integration for the ink narrative scripting language

• Action Adventure Kit
• Ink

Setup

The packages are not included in this repository and have to be downloaded separately so after cloning the project will be missing the Ink and SoftLeitner folders.

You only need the AdventureCore folder from AAK for this integration demo. Download it from the asset store or copy it from another project you have previously used it in if you want to avoid the errors when opening a project that is missing a lot of its files.

The unity integration for ink can also be found on the asset store and downloaded directly or as a UPM package as described on github

Once you have downloaded the two dependencies you start to try out the integration. Open and play the AAK_Ink scene which contains examples for a lot of the functionality. The stories can be found in the Stories subfolder which can be edited using the awesome Inky. The AAK_Ink_Shared scene contains an example for a use case where we want multiple different actions to use the same story and state.

Tags

InkAction currently handles two tags in its storyContinued method. This method is overridable which any derived action can take advantage of to implement additional tags.

• character:N
  This tag sets which character is currently active in the dialog. N is the character index which is 0 for the executing character(player) and 1-... for the characters set in the Characters field of the action(NPCs). Changing the current character is handled in setCurrentCharacter. Currently all it does is align the characters so all of them look at the current one, you can override the method to add additional behavior like for example a portrait.
• trigger:ParameterName
  Sets a trigger on the animator of the currently active character.

Functions

All the different functions are bound in createStory which can be overridden if additional functions need to be added in derived actions.

General

• SetBool(name,value), SetInt(name,value), SetFloat(name,value)
  SetCharacterBool(character,name,value), SetCharacterInt(character,name,value), SetCharacterFloat(character,name,value)
  Set parameters of different types in character animators, the variations with character in their name let you specify which character by adding a character index as the first parameter.(used in the functions example to make a characters shake)
• OnMessages(messages) / OnCharacterMessages(character,messages)
  Will publish messages to a character, multiple messages can be split with space.(used in the functions example to publish a "Ping" message which, using a message event on the player, plays a sound)

Persistence

• GetPersistedBool(key), GetPersistedInt(key), GetPersistedFloat(key), GetPersistedString(key)
  Can be used to retrieve a value from the persister set in the FunctionPersister field of the InkAction.
• SetPersistedBool(key,value), SetPersistedInt(key,value), SetPersistedFloat(key,value), GetPersistedString(key,value)
  Can be used to set a value in the persister set in the FunctionPersister field of the InkAction. Both Set and Set functions are demonstrated in the Persistence example.

Items

• GetItemQuantity(key) / GetCharacterItemQuantity(int,key)
  These return how many of the item of the specified key the character currently has in its inventory.
• CanAddItems(key,quantity), CanRemoveItems(key, quantity)
  CanCharacterAddItems(character,key,quantity), CanCharacterRemoveItems(character,key,quantity)
  These check if items can be either added to or removed from a characters inventory. For example nothing can be removed from an empty inventory and nothing can be added to a full one.
• AddItems(key,quantity), RemoveItems(key, quantity)
  AddCharacterItems(character,key,quantity), RemoveCharacterItems(character,key,quantity)
  Will add or remove items from the characters inventors. The key has to match the one of the items in the item set on the InkAction Items field.

Effects

• HasEffect(key) / HasCharacterEffect(int,key)
  These check if an effect is currently active in a characters effect pool.
• AddEffect(key), RemoveEffect(key)
  AddCharacterEffect(character,key), RemoveCharacterEffect(character,key)
  Will add or remove an effect from the characters effect pool. The key has to match the one of the effects in the effect set on the InkAction Effects field.