HasFunction method evaluates regular knots as True

[WolvenBard]

Context:

I have two ink containers, one a regular knot, and the other a function:

=== goblin_talk ===
...

=== function has_revived ===
...

If I call upon Story.cs's method HasFunction, it evaluates both goblin_talk and has_revived as True (and therefore functions).

This seems to me as incorrect. goblin_talk is a regular knot and should evaluate to False, while has_revived is a function knot and should evaluate to True.

This can lead to accidentally attempting to evaluate a non-function knot which then results with the following exception:

Exception: Expected external function evaluation to be complete. Stack trace: === THREAD 1/1 (current) ===
  [TUNNEL] 
Ink.Runtime.StoryState.CompleteFunctionEvaluationFromGame () (at Assets/Ink/InkLibs/InkRuntime/StoryState.cs:1265)
Ink.Runtime.Story.EvaluateFunction (System.String functionName, System.String& textOutput, System.Object[] arguments) (at Assets/Ink/InkLibs/InkRuntime/Story.cs:1868)
Ink.Runtime.Story.EvaluateFunction (System.String functionName, System.Object[] arguments) (at Assets/Ink/InkLibs/InkRuntime/Story.cs:1822)
Core.StoryManager.EvaluateFunction (System.String function, System.Object[] arguments) (at Assets/Scripts/Nosfuratu/Managers/StoryManager.cs:404)

Problem:

I'm looking at the HasFunction defined in Story.cs. It looks like it's not exclusive to just functions, and actually returns True for values that represent regular knots (not functions).

Looking at the implementation of the method, this makes sense as it is calling upon KnotContainerWithName which in turn is just searching the contents of the main container:

public bool HasFunction (string functionName)
{
    try {
        return KnotContainerWithName (functionName) != null;
    } catch {
        return false;
    }
}

...

public Runtime.Container KnotContainerWithName (string name)
{
    INamedContent namedContainer;
    if (mainContentContainer.namedContent.TryGetValue (name, out namedContainer))
        return namedContainer as Container;
    else
        return null;
}

Is this an oversight?

Attempted Solutions:

Looking at the containers themselves, there doesn't really seem to be a clear way to discern if a container is a regular Knot or a Function. The only thing I can see is that if I search within the contents of the container, Functions tend to have a ControlCommand entry labeled PopFunction

This may be one way to discern, but seems hacky. Not sure if that PopFunction could appear elsewhere other than an explicit function knot.

I've posted a pull request with this solution here:
#210

[tomkail]

Hi! Can you please post this on the main Ink repo? This one is mostly just a Unity wrapper for it. I agree that this wants improving though, it’s gotten me in the past too. Ta!

…

On Tue, Dec 31, 2024 at 21:50 Shervin Mortazavi ***@***.***> wrote: Context: I have two ink containers, one a regular knot, and the other a function: === goblin_talk === ... === function has_revived === ... If I call upon Story.cs's method HasFunction, it evaluates both goblin_talk and has_revived as functions. Problem: I'm looking at the HasFunction defined in Story.cs. It looks like its not exclusive to just functions, and actually returns True for values that represent regular knots (not functions). Looking at the implementation of the method, this makes sense as it is calling upon KnotContainerWithName which in turn is just searching the contents of the main container: public Runtime.Container KnotContainerWithName (string name) { INamedContent namedContainer; if (mainContentContainer.namedContent.TryGetValue (name, out namedContainer)) return namedContainer as Container; else return null; } Is this an oversight? Attempted Solutions: Looking at the containers themselves, there doesn't really seem to be a clear way to discern if a container is a regular Knot or a Function. The only thing I can see is that if I search within the contents of the container, Functions tend to have a ControlCommand entry labeled PopFunction This may be one way to discern, but seems hacky. Not sure if that PopFunction could appear elsewhere other than an explicit function knot. — Reply to this email directly, view it on GitHub <#209>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJR3UEJYFSY7HYJOFBWW5T2IMGRBAVCNFSM6AAAAABUN6GKX2VHI2DSMVQWIX3LMV43ASLTON2WKOZSG43DINRZGE3DEOA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[WolvenBard]

@tomkail Certainly, happy to repost this issue on there as well.

Would you like me to replicate this pull request on the main repo as well?
#210

I assume the fix would want to be on both repos?

[tomkail]

Yes please! I’ll merge it in if Joe accepts the commit on the ink repo. Ta!

…

On Thu, Jan 2, 2025 at 22:24 Json Bool ***@***.***> wrote: @tomkail <https://github.com/tomkail> Certainly, happy to repost this issue on there as well. Would you like me to replicate this pull request on the main repo as well? #210 <#210> I assume the fix would want to be on both repos? — Reply to this email directly, view it on GitHub <#209 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJR3UC2JXPBU27T4OMLDXD2IW4B5AVCNFSM6AAAAABUN6GKX2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNRYGQ2TKOBWGE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[WolvenBard]

Thanks @tomkail. I've reposted here:

Issue: inkle/ink#928
Pull Request: inkle/ink#927