JornAggror Blog

Including the second API snippet that starts with “Entity:” is interesting because if you ever want to know what functions are available for that class you can just start typing “ent...”

Seeing all the API in VSCode is pretty awesome. It looks like this is your raw input from the docs:

SetRotation(number pitch, number yaw, number roll,  bool global=false)

And you will want to turn that into this:

SetRotation(&pitch, &yaw, &roll, &global)

 

7 hours ago, Josh said:

Seeing all the API in VSCode is pretty awesome. It looks like this is your raw input from the docs:

SetRotation(number pitch, number yaw, number roll,  bool global=false)

And you will want to turn that into this:

SetRotation(&pitch, &yaw, &roll, &global)

 

Yeah those parameters need some work. What do you think looks better? Your post or the thing below?

SetRotation($number_pitch, $number_yaw, $number_roll, $bool_global=false)
SetRotation($vec3_rotation, $bool_global=false)

On one hand I don't want to lose the type, but on the other hand it looks uglier. Both are just easily made so its just a matter of picking a style.

Keep the types. It's more functional even if it looks uglier.

Maybe something like this would work:
 

	"Entity:SetPosition": {
		"prefix": "SetPosition",
		"body": "SetPosition($x,$y,$z,$global)",
		"description": "Entity Method\nSets the position of an entity in 3-dimensional space, using local or global coordinates.\nParameters\nx (number): X component of the position to set.\ny (number): Y component of the position to set.\nz (number): Z component of the position to set.\nglobal (boolean): uses global space if set to true, otherwise local space is used."
	},

 

I'm not sure, the popup window in VSCode is pretty small.

The popup window can be restyled I think. I haven't tried it yet, but it is basically css so perhaps it is fairly easy to achieve a larger width.

Adding the parameter information to the description could work. This way I can also add 'cleaner' parameter names. As long as the documentation holds up to its current parameter convention, it can be easily transformed. 

type name: "number x" or "bool ignoreCollision"
type name=value: "bool global=true" or "number velocity = 1.0"

Fyi: at https://www.leadwerks.com/learn?page=API-Reference_Object_Entity_SetPosition the first syntax is missing a comma.

• SetPosition(number x number y, number z, bool global = false)

Small update published: I have added the parameters as indexes as well. The syntax is converted from

SetRotation(number pitch, number yaw, number roll,  bool global=false)

to

SetRotation(pitch, yaw, roll, global)

The description contains the explanation of the parameters. see image below. It is not waterproof though. Sometimes the syntax parameters are missing in the description, causing the description to be empty or imcomplete. You can identify mistakes/incomplete information in the documentation easier this way.

 The biggest downside at the moment is the way Vs code scales the intellisense window. Right now that is not optimal. However there is word that they are working on that by making the styling more accessible through settings. In the image below I applied custom styling to make the width 2 x its original size.

AddForce command with 2 different versions of paramters.

 

@AggrorJorn There is a trash can icon in the lower-right of the image thumbnail in the editor. It's easy to miss.

Why does it have ".," at the end of each line? Why does it say (Leadwerks) on the last line?

Because the description was written in array form I need to use comma's to specify a new line. The extension somehow included that comma. I can solve this by just cramming everything on 1 line. It is not that people would read that document anyway. Why the ' Leadwerks' is inserted is not clear to me yet. It is not comming from the code and does also not appear in the snippet file. Vs code is adding it for some reason.

Pushed a new build that fixes the comma.