Scripting Hooks

From Star Ruler

Jump to: navigation, search

Here is a list of all values and functions bound to the AngelScript engines.

All values and functions will have an associated engine icon, specifying which of the two Angelscript engines - the Server and Client - the value or function is available on:

File:Scr_server.png Only on the Server engine.
File:Scr_client.png Only on the Client engine.
File:Scr_both.png On both the Server and Client engines.

Contents

Debugging

File:Scr_both.png print
File:Scr_both.png warning
File:Scr_both.png error
Script Test Mode

Special

File:Scr_both.png array

Enumerations

File:Scr_client.png ButtonAppearance
File:Scr_both.png DiploAttitude
File:Scr_both.png DiploMood
File:Scr_both.png DiploTopic
File:Scr_client.png ElementAlignment
File:Scr_server.png EventState
File:Scr_both.png FleetFormation
File:Scr_server.png GoalID
File:Scr_client.png GUIEventType
File:Scr_client.png MouseEventType
File:Scr_both.png OrderArgumentType
File:Scr_both.png OrderType
File:Scr_server.png ParameterWeight
File:Scr_client.png ScrollBarMode
File:Scr_server.png SubSystemEvalMode
File:Scr_both.png SysState
File:Scr_server.png TransferMode

Structures

File:Scr_both.png dim2di
File:Scr_both.png dim2df
File:Scr_both.png pos2di
File:Scr_both.png pos2df
File:Scr_both.png recti
File:Scr_both.png rectf
File:Scr_both.png vector
File:Scr_server.png Star_Desc
File:Scr_server.png Planet_Desc
File:Scr_server.png Hull_Desc

Classes

File:Scr_client.png Clause
File:Scr_client.png ClauseDesc
File:Scr_client.png ClauseOption
File:Scr_client.png Color
File:Scr_both.png dictionary
File:Scr_both.png DiploMsg
File:Scr_both.png Effect
File:Scr_both.png Effector
File:Scr_both.png EffectorState
File:Scr_both.png Emperor
File:Scr_both.png Empire
File:Scr_both.png EmpireObjects
File:Scr_both.png EmpireMessages
File:Scr_both.png EmpireTraits
File:Scr_both.png EmpireTreaties
File:Scr_both.png empSysData
File:Scr_server.png Event
File:Scr_both.png Fleet
File:Scr_both.png FleetFormer
File:Scr_both.png Galaxy
File:Scr_both.png GalaxySystemList
File:Scr_client.png GuiElement
File:Scr_both.png Hull_Desc
File:Scr_both.png HulledObj
File:Scr_both.png HullLayout
File:Scr_both.png HullStats
File:Scr_both.png Object
File:Scr_both.png ObjDockedList
File:Scr_both.png Oddity
File:Scr_both.png Oddity_Desc
File:Scr_both.png Orbit_Desc
File:Scr_both.png Order
File:Scr_both.png OrderArgument
File:Scr_both.png OrderDescriptor
File:Scr_both.png OrderList
File:Scr_both.png Planet
File:Scr_both.png Planet_Desc
File:Scr_both.png PlanetCondition
File:Scr_both.png PlanetType
File:Scr_both.png PlanetStructureList
File:Scr_both.png ResearchWeb
File:Scr_both.png Resource
File:Scr_both.png set_int
File:Scr_both.png ShipDesign
File:Scr_both.png Star
File:Scr_both.png Star_Desc
File:Scr_both.png State
File:Scr_both.png string
File:Scr_both.png subSystem
File:Scr_both.png subSystemDef
File:Scr_both.png SubSystemFactory
File:Scr_both.png SysObjList
File:Scr_both.png SysPresence
File:Scr_both.png SysRef
File:Scr_both.png SysSearchSettings
File:Scr_both.png SysSearchCallback
File:Scr_both.png SysStats
File:Scr_both.png System
File:Scr_both.png System_Desc
File:Scr_both.png SystemStats
File:Scr_both.png SystemTags
File:Scr_both.png Trait
File:Scr_both.png Treaty
File:Scr_both.png TreatyFactory
File:Scr_both.png WebItem
File:Scr_both.png WebItemDesc
File:Scr_both.png XMLList
File:Scr_both.png XMLReader
File:Scr_both.png XMLWriter

Functions

Mathematic Functions
Formula
File:Scr_both.png getGameSetting
File:Scr_both.png getActiveEmpire
File:Scr_client.png animate
File:Scr_client.png bindGuiCallback
File:Scr_client.png getScreenHeight
File:Scr_client.png getScreenWidth
File:Scr_client.png reserveGuiID
File:Scr_client.png selectObject
File:Scr_client.png setCameraFocus

Globals

Callbacks

File:Scr_client.png onGuiEvent

Errors

In the event of an error, you may receive an error id. Possible error ids are listed below:

0: Success (not an error)
-1: Unspecified error
-6: No matching function
-14: Multiple matching functions (ambiguous function)
-17: Severe engine fault
-19: Not all imported functions could be bound (error in external modules)

Other error codes indicate varying types of engine faults.

Personal tools