The pages associated to this page cover the syntax of ZPE/YASS as well as some underlying development strategies and some of the key concepts. If you are using the ZPE Programming Environment or YASS you should find this set of pages very useful.
The current version of the ZPE Programming Environment is 1.12.8 (built 30-07-2024, known as Nessie Newt). The documentation found in this manual will be, for the most part, related only to this version of the ZPE Programming Environment and YASS version onwards.
This documentation is specific to my ZPE/YASS implementation.
Getting started
When you have downloaded the ZPE Programming Environment executable you will need to know how to use it.
ZPE Programming Environment runtime features
The following is a list of all the main features of the YASS language:
Expressions
The following is a list of all the syntax for all of the language expressions available in YASS:
Language constructs
The following is a list of all the syntax for all of the language constructs for YASS:
Data types
Built-in object syntax documents
The following documentation covers objects built-in to the language itself and how they work as well as their exposed functions.
Predefined functions
The following is a concise list of all built-in functions and links to pages dedicated to them. There is more information on predefined functions above.
The list is always in sync with the latest version of ZPE because
it comes from ZPE itself (since version 1.8.2). You can generate this list
using the json_encode(list_zpe_functions())
within the engine itself
as I do.
Core
- get_version [1.6.6+]
- write_cache_value [1.6.6+]
- read_cache_value [1.6.6+]
- list_cache_values [1.8.6+]
- run_script [1.3.5+]
- run_command [1.3.5.62+]
- exit [1.3.1+]
- shell [1.3.1+]
- get_zpe_property [1.5.1+]
- std_new_line [1.5.2+]
- throw_error [1.4.3.40+]
- write_log [1.12.8+]New
- handle_of [1.3.7.0+]
- copy_of [1.9.13+]
- permission_level_of [1.4.0.23+]
- list_local_variables [1.3.7.44+]
- list_parameters [1.3.7.44+]
- list_global_variables [1.3.7.44+]
- create_variable [1.8.12+]
- is_function [1.8.2+]
- get_call_stack [1.6.7+]
- get_function_information [1.8.7+]
- list_zpe_functions [1.8.2+]
- list_zpe_aliases [1.8.10+]
- list_plugins [1.8.7+]
- supports [1.4.4.0+]
- feedback [1.5.0+]
- get_nanoseconds [1.5.1+]
- wait [1.5.3+]
- do_nothing [1.6.3+]
- function_exists [1.10.1+]
- run_in_thread [1.7.9+]
- run_in [1.10.7+]
- run_at [1.8.1+]
- time [1.8.1+]
- list_object_properties [1.8.2+]
- get_object_property [1.8.2+]
System
I/O
Networking
Mathematical
- sine [1.3.1+]
- cosine [1.3.1+]
- tangent [1.3.1+]
- absolute_value [1.3.1+]
- square_root [1.3.1+]
- cube_root [1.3.7.0+]
- factorial [1.3.1+]
- is_prime_number [1.8.2+]
- sign [1.9.12+]
- floor [1.3.1+]
- ceiling [1.3.1+]
- round [1.3.1+]
- significant_figures [1.3.7.25+]
- limit_real [1.3.5.32+]
- random_number [1.3.1+]
- value [1.3.1+]
- remove_exponent [1.3.5.90+]
- range [1.4.1.0+]
- range_inclusive [1.6.6+]
- counter [1.4.1.0+]
- to_binary [1.3.4.90+]
- to_octal [1.3.4.90+]
- to_hexadecimal [1.3.4.90+]
- to_denary [1.6.6+]
- greater_than_all [1.3.1+]
- greater_than_any [1.4.4+]
- less_than_all [1.3.3.1+]
- less_than_any [1.4.4+]
- equals_any [1.3.4+]
- all_true [1.3.7.89+]
- all_false [1.3.7.89+]
- any_true [1.3.7.89+]
- any_false [1.3.7.89+]
- xor [1.4.3+]
- implies [1.7.4+]
- iif [1.12.6+]Updated
- nor [1.7.4+]
- get_minimum [1.3.3+]
- get_maximum [1.3.3+]
- get_range [1.3.3+]
- get_mean [1.3.3+]
- get_mode [1.3.3+]
- get_median [1.3.3+]
- evaluate [1.7.4+]
Encryption and decryption
String
- integer_to_character [1.3.3+]
- character_to_integer [1.3.3+]
- string_to_list [1.9.13+]
- string_get_character_at [1.3.1+]
- string_get_length [1.3.1+]
- string_contains [1.3.2+]
- string_split [1.3.3+]
- string_splice [1.5.0.1+]
- string_divide [1.5.0.1+]
- string_find_occurrences [1.3.3+]
- string_get_substring [1.3.3+]
- string_to_lowercase [1.3.3+]
- string_to_uppercase [1.3.3+]
- string_replace [1.3.3+]
- string_starts_with [1.3.3+]
- string_ends_with [1.3.3+]
- string_cut [1.5.0+]
- string_trim [1.3.5.90+]
- string_trim_start [1.3.5.90+]
- string_trim_end [1.3.5.90+]
- string_matches [1.3.3+]
- string_to_date [1.3.4+]
- string_is_numeric [1.3.2+]
- string_is_lowercase [1.3.7.1+]
- string_is_uppercase [1.3.7.1+]
- string_text_compare [1.7.9+]
- string_compare [1.11.12+]
- input_validate [1.7.3+]
- beautify [1.7.5+]
- generate_random_string [1.9.2+]
- generate_alphabet [1.4.4+]
- format_string [1.9.9+]
- speak [1.8.2+]
File
List
- array_to_list [1.7.6+]
- list_get_data_type [1.7.10+]Updated
- list_to_array [1.7.6+]
- list_add_element [1.3.1+]
- list_remove_element [1.3.1+]
- list_get_at_index [1.3.2+]
- list_get_at_random_index [1.4.4+]
- list_shuffle [1.8.2+]
- list_compress [1.8.9+]
- list_pop [1.4.2+]
- list_dequeue [1.4.2+]
- list_get_length [1.3.2+]
- list_contains [1.3.2+]
- list_contains_all [1.9.13+]
- list_get_index_of [1.3.3+]
- list_count_occurrences [1.8.3+]
- list_count_if [1.8.3+]
- list_find_duplicates [1.7.8+]
- list_insert_at_index [1.3.3+]
- list_set_at_index [1.3.4.90+]
- list_reverse [1.3.3+]
- list_sort [1.3.4+]
- list_swap_elements [1.3.3+]
- list_join [1.3.3+]
- list_slice [1.7.6+]
- list_is_a_set [1.3.7.1+]
- list_populate [1.7.3+]
- list_auto_populate [1.7.6+]
- list_process [1.7.6+]
- list_combine [1.8.7+]
- list_compose [1.10.1+]
Set
Maps
Data
Old functions that have since been removed but still have documentation are available here.