Naming Conventions

Purpose

The Rapise engine and API follow some simple naming conventions.

Usage

You will find descriptions of the naming conventions below.  Note: italicized text represents placeholders.

  • SeS*<...>* - public functions for user
  • Do*<Action>* - action implementations
  • _<somevar> and _<somename> - private functions and objects
  • g_<varname> - system global variable.

Examples

Here are some examples to clarify the above conventions:

SeS("object") // gets the object named "object"
DoClick()     // public action function to click on something
_mydata       // private variable called mydata
g_publicdata  // global variable called publicdata