Home | Documentation | Atomic Chat | Github

Need Code Examples in API References


I noticed that many (maybe most) of the entries in the API references don’t feature any examples of the methods, etc. listed there in use.

For instance, I want to experiment with ray casting in Atomic. I found a couple of methods in the ref docs that have the word “ray” in them but there is little else there to describe what they do or how to write calls to them. Mind you, I’m not talking about a code example, just an example of the syntax.

How are folks generally figuring out how to use this stuff? Is there another resource that I should be using?




The documentation surely needs some work. I also have trouble sometimes figuring how to use the API, but (3D) raycasting is quite self-explanatory (this is C#):


You have to pass two objects: PhysicsRaycastResult as reference, which is going to contain the resulting data, and Ray which just contains two 3D vectors (origin and direction). After the cast is performed the object that was hit is in the PhysicsRaycastResult.Body property (null if none).

I don’t think there’s scripting API to perform 2D casts yet, but I could be wrong here.

For a complete beginner I think Atomic could be a bit confusing, but the API is quite standard in my opinion, maybe there’s a couple of unusual namings but nothing an intermediate developer can’t figure out, beginners can count on our amazing :camel: community for help :wink:. We surely need more tutorials and better documentation. We have some ongoing efforts on that, including our Wiki on GitHub.

Best regards


Seriously, if anyone with AGE knowledge is looking for something to do, I would vote for fleshing out the docs with a one line syntax example for each entry.

It would be a huge help!



unity docs are good for a reason