[function] explanation of pargs required

[mrkrunkles]

Hello, could you elaborate on the correct method to pass a variable to a user defined function?

I am trying every combination of syntax I can think of to get the following to work, I want to pass the term 'apple' into the function when called so that apple is called as the prompt:

[function test, my_parg] [# define function]
my_parg
[/function]

[call test, apple] [# set apple as the prompt]

but I cannot make it work correctly, I apologise if this is obvious I do not have a coding background but am enjoying using unprompted.

[ThereforeGames]

Hi @mrkrunkles,

Thank you for reaching out.

Let me try to address your question about using custom arguments with [function] - it's a little complex, so bear with me:

• Pargs, or positional arguments, can be passed into [function] to set boolean (i.e. true/false) variables to True. For example, if you declare [function my_func some_parg], and then [call my_func], the variable some_parg will automatically be True and ready for use within your function.

• I think what you're looking for are kwargs, or keyword arguments. You can set these to anything you want and you can give them default values. Let's modify your example:

[function my_func some_kwarg="these are the default words"]
[get some_kwarg]
[/function]

Notice that 1) we do not use commas here and 2) in order to retrieve the value of some_kwarg we must [get some_kwarg] within the function.

Now we can [call my_func] and it will return: these are the default words.

More importantly, we can override the value of some_kwarg as shown:

[call my_func some_kwarg="apple"]

...which will cause the function to return apple.

I hope that makes sense. Please let me know if you have any other questions.

[mrkrunkles]

Thankyou very much for the response, I understand now.

[redactedaccount]

why is this buried here and not in the documentation?

[ThereforeGames]

@redactedaccount Which part isn't covered in the documentation? The [function] shortcode is described in the manual here:

https://github.com/ThereforeGames/unprompted/wiki/Shortcodes#function

It mostly covers the same ground as my post, but I'd be happy to improve the wording if you have any specific suggestions. Thanks!