Enforce script essentials

Data Structures
class	array< Class T >
class	Class
	Super root of all classes in Enforce script. More...
class	EnScript
class	Managed
	TODO doc. More...
class	map< Class TKey, Class TValue >
	Associative array template usage: More...
class	NonSerialized
	TODO doc. More...
class	Obsolete
	Marks method as obsolete. More...
class	ScriptModule
	Module containing compiled scripts. More...
class	set< Class T >

Typedefs
typedef int	MapIterator
typedef array< bool >	TBoolArray
typedef array< Class >	TClassArray
typedef map< Class, Class >	TClassClassMap
typedef map< Class, float >	TClassFloatMap
typedef map< Class, int >	TClassIntMap
typedef map< Class, Managed >	TClassManagedMap
typedef map< Class, ref Managed >	TClassManagedRefMap
typedef set< Class >	TClassSet
typedef map< Class, string >	TClassStringMap
typedef map< Class, typename >	TClassTypenameMap
typedef map< Class, vector >	TClassVectorMap
typedef array< float >	TFloatArray
typedef set< float >	TFloatSet
typedef array< int >	TIntArray
typedef map< int, Class >	TIntClassMap
typedef map< int, float >	TIntFloatMap
typedef map< int, int >	TIntIntMap
typedef map< int, Managed >	TIntManagedMap
typedef map< int, ref Managed >	TIntManagedRefMap
typedef set< int >	TIntSet
typedef map< int, string >	TIntStringMap
typedef map< int, typename >	TIntTypenameMap
typedef map< int, vector >	TIntVectorMap
typedef array< Managed >	TManagedArray
typedef map< Managed, Class >	TManagedClassMap
typedef map< Managed, float >	TManagedFloatMap
typedef map< Managed, int >	TManagedIntMap
typedef map< Managed, Managed >	TManagedManagedMap
typedef map< Managed, ref Managed >	TManagedManagedRefMap
typedef array< ref Managed >	TManagedRefArray
typedef map< ref Managed, Class >	TManagedRefClassMap
typedef map< ref Managed, float >	TManagedRefFloatMap
typedef map< ref Managed, int >	TManagedRefIntMap
typedef map< ref Managed, Managed >	TManagedRefManagedMap
typedef map< ref Managed, ref Managed >	TManagedRefManagedRefMap
typedef set< ref Managed >	TManagedRefSet
typedef map< ref Managed, string >	TManagedRefStringMap
typedef map< ref Managed, typename >	TManagedRefTypenameMap
typedef map< ref Managed, vector >	TManagedRefVectorMap
typedef set< Managed >	TManagedSet
typedef map< Managed, string >	TManagedStringMap
typedef map< Managed, typename >	TManagedTypenameMap
typedef map< Managed, vector >	TManagedVectorMap
typedef array< string >	TStringArray
typedef map< string, Class >	TStringClassMap
typedef map< string, float >	TStringFloatMap
typedef map< string, int >	TStringIntMap
typedef map< string, Managed >	TStringManagedMap
typedef map< string, ref Managed >	TStringManagedRefMap
typedef set< string >	TStringSet
typedef map< string, string >	TStringStringMap
typedef map< string, typename >	TStringTypenameMap
typedef map< string, vector >	TStringVectorMap
typedef array< typename >	TTypenameArray
typedef map< typename, Class >	TTypeNameClassMap
typedef map< typename, float >	TTypeNameFloatMap
typedef map< typename, int >	TTypeNameIntMap
typedef map< typename, Managed >	TTypeNameManagedMap
typedef map< typename, ref Managed >	TTypeNameManagedRefMap
typedef set< typename >	TTypenameSet
typedef map< typename, string >	TTypeNameStringMap
typedef map< typename, typename >	TTypeNameTypenameMap
typedef map< typename, vector >	TTypeNameVectorMap
typedef array< vector >	TVectorArray
typedef int[]	TypeID
	script representation for C++ RTTI types

Functions
void	EnScript ()
void	Obsolete (string msg="")
void	~EnScript ()
void	~ScriptModule ()
proto native MapIterator	Begin ()
proto volatile int	Call (Class inst, string function, void parm)
	dynamic call of function when inst == NULL, it's global function call, otherwise it's method of class returns true, when success The call creates new thread, so it's legal to use sleep/wait
proto volatile int	CallFunction (Class inst, string function, out void returnVal, void parm)
	dynamic call of function when inst == NULL, it's global function call, otherwise it's method of class returns true, when success The call do not create new thread!
proto volatile int	CallFunctionParams (Class inst, string function, out void returnVal, Class parms)
static proto Class	Cast (Class from)
	Try to safely down-cast base class to child class.
static proto bool	CastTo (out Class to, Class from)
	Try to safely down-cast base class to child class.
proto native owned external string	ClassName ()
	Returns name of class-type.
proto native void	Clear ()
	Destroyes all elements of the array and sets the Count to 0.
proto native void	Clear ()
	Clears the hash map.
proto native void	Clear ()
proto bool	Contains (TKey key)
	Returns if map contains element with given key.
proto int	Copy (notnull array< T > from)
	Copes contents of from array to this array.
proto int	Copy (map< TKey, TValue > from)
proto int	Copy (set< T > from)
proto void	copyarray (void destArray, void srcArray)
proto native int	Count ()
	O(1) complexity.
proto native int	Count ()
proto native int	Count ()
void	Debug ()
	Print all elements in array.
void	Debug ()
int	DifferentAtPosition (array< T > pOtherArray)
	Returns an index where 2 arrays start to differ from each other.
proto native MapIterator	End ()
proto int	Find (T value)
	Tries to find the first occurance of given value in the array.
proto bool	Find (TKey key, out TValue val)
	Search for an element with the given key.
proto int	Find (T value)
	Tries to find the first occurance of given value in the set.
proto T	Get (int n)
proto TValue	Get (TKey key)
	Search for an element with the given key.
proto T	Get (int n)
static proto int	GetClassVar (Class inst, string varname, int index, out void result)
	Dynamic read of variable value by its name.
string	GetDebugName ()
proto TValue	GetElement (int index)
	Return the i:th element in the map.
proto TValue	GetIteratorElement (MapIterator it)
proto TKey	GetIteratorKey (MapIterator it)
proto TKey	GetKey (int i)
	Return the i:th element key in the map.
array< TKey >	GetKeyArray ()
TKey	GetKeyByValue (TValue value)
bool	GetKeyByValueChecked (TValue value, out TKey key)
T	GetRandomElement ()
	Returns a random element of array.
int	GetRandomIndex ()
	Returns a random index of array.
array< TValue >	GetValueArray ()
proto volatile void	Idle ()
	Yiels execution to other threads and then it continues.
proto int	Init (T init[])
proto int	Init (T init[])
proto int	Insert (T value)
	Inserts element at the end of array.
proto bool	Insert (TKey key, TValue value)
	Insert new element into hash map.
proto int	Insert (T value)
	Inserts element at the end of array.
void	InsertAll (notnull array< T > from)
	Inserts all elements from array.
void	InsertArray (array< T > other)
proto int	InsertAt (T value, int index)
	Inserts element at certain position and moves all elements behind this position by one.
proto int	InsertAt (T value, int index)
	Inserts element at certain position and moves all elements behind this position by one.
void	InsertSet (set< T > other)
void	Invert ()
proto native external bool	IsInherited (typename type)
	Returns true when instance is of the type, or inherited one.
bool	IsValidIndex (int index)
proto native int	KillThread (Class owner, string name)
	Kills thread.
static proto native ScriptModule	LoadScript (ScriptModule parentModule, string scriptFile, bool listing)
	Do load script and create ScriptModule for it.
int	MoveIndex (int curr_index, int move_number)
	Returns a index in array moved by specific number.
proto native MapIterator	Next (MapIterator it)
void	Obsolete (string msg="")
proto int	ParseString (string input, out string tokens[])
	Parses string into array of tokens returns number of tokens.
proto int	ParseStringEx (inout string input, string token)
	Parses one token from input string.
Obsolete Managed	PrintString (string s)
	Helper for printing out string expression. Example: PrintString("Hello " + var);.
proto native void	Release ()
proto native void	Remove (int index)
	Removes element from array.
proto void	Remove (TKey key)
	Removes element with given key.
proto native void	Remove (int index)
	Removes element from array, but retain all elements ordered.
proto void	RemoveElement (int i)
	Removes i:th element with given key.
void	RemoveItem (T value)
void	RemoveItem (T value)
void	RemoveItems (set< T > other)
void	RemoveItemUnOrdered (T value)
proto native void	RemoveOrdered (int index)
	Removes element from array, but retain all elements ordered.
bool	ReplaceKey (TKey old_key, TKey new_key)
proto native void	Reserve (int newSize)
	Resizes the array to given size internally.
proto native void	Resize (int newSize)
	Resizes the array to given size.
proto void	reversearray (void param_array)
static proto bool	SafeCastType (Class type, out Class to, Class from)
	This function is for internal script usage.
proto void	Set (int n, T value)
	Sets n-th element to given value.
proto void	Set (TKey key, TValue value)
	Sets value of element with given key.
static proto int	SetClassVar (Class inst, string varname, int index, void input)
	Dynamic write to variable by its name.
static proto int	SetVar (out void var, string value)
	Sets variable value by value in string.
void	ShuffleArray ()
proto native void	Sort (bool reverse=false)
	Sorts elements of array, depends on underlaying type.
proto void	Sort (void param_array[], int num)
	Sorts static array of integers(ascendically) / floats(ascendically) / strings(alphabetically).
static	StaticGetType (typename t)
	Returns typename of class even without a variable or instance.
proto static external	StaticType ()
	Returns typename of object's reference.
string	String (string s)
	Helper for passing string expression to functions with void parameter. Example: Print(String("Hello " + var));.
proto native void	Swap (notnull array< T > other)
	Swaps the contents of this and other arrays.
proto native void	Swap (set< T > other)
void	SwapItems (int item1_index, int item2_index)
proto owned string	ThreadFunction (Class owner, string name, int backtrace, out int linenumber)
	Debug function.
proto external string	ToString ()
proto native external	Type ()
	Returns typename of object's class.
static proto void	Watch (void var, int flags)
	Debug tool for watching certain variable.

Variables
string	m_Msg
string	m_Msg
class array< Class T >	PrintString

Detailed Description

Note

float ftime; The deltaTime since last frame

float FLT_MAX; The maximum value for float

float FLT_MIN; The minimum value for float

Typedef Documentation

MapIterator

typedef int MapIterator

Definition at line 810 of file enscript.c.

TBoolArray

typedef array<bool> TBoolArray

Definition at line 715 of file enscript.c.

TClassArray

typedef array<Class> TClassArray

Definition at line 716 of file enscript.c.

TClassClassMap

typedef map<Class, Class> TClassClassMap

Definition at line 995 of file enscript.c.

TClassFloatMap

typedef map<Class, float> TClassFloatMap

Definition at line 992 of file enscript.c.

TClassIntMap

typedef map<Class, int> TClassIntMap

Definition at line 993 of file enscript.c.

TClassManagedMap

typedef map<Class, Managed> TClassManagedMap

Definition at line 996 of file enscript.c.

TClassManagedRefMap

typedef map<Class, ref Managed> TClassManagedRefMap

Definition at line 997 of file enscript.c.

TClassSet

typedef set<Class> TClassSet

Definition at line 805 of file enscript.c.

TClassStringMap

typedef map<Class, string> TClassStringMap

Definition at line 994 of file enscript.c.

TClassTypenameMap

typedef map<Class, typename> TClassTypenameMap

Definition at line 998 of file enscript.c.

TClassVectorMap

typedef map<Class, vector> TClassVectorMap

Definition at line 999 of file enscript.c.

TFloatArray

typedef array<float> TFloatArray

Definition at line 713 of file enscript.c.

TFloatSet

typedef set<float> TFloatSet

Definition at line 803 of file enscript.c.

TIntArray

typedef array<int> TIntArray

Definition at line 714 of file enscript.c.

TIntClassMap

typedef map<int, Class> TIntClassMap

Definition at line 977 of file enscript.c.

TIntFloatMap

typedef map<int, float> TIntFloatMap

Definition at line 974 of file enscript.c.

TIntIntMap

typedef map<int, int> TIntIntMap

Definition at line 975 of file enscript.c.

TIntManagedMap

typedef map<int, Managed> TIntManagedMap

Definition at line 978 of file enscript.c.

TIntManagedRefMap

typedef map<int, ref Managed> TIntManagedRefMap

Definition at line 979 of file enscript.c.

TIntSet

typedef set<int> TIntSet

Definition at line 804 of file enscript.c.

TIntStringMap

typedef map<int, string> TIntStringMap

Definition at line 976 of file enscript.c.

TIntTypenameMap

typedef map<int, typename> TIntTypenameMap

Definition at line 980 of file enscript.c.

TIntVectorMap

typedef map<int, vector> TIntVectorMap

Definition at line 981 of file enscript.c.

TManagedArray

typedef array<Managed> TManagedArray

Definition at line 717 of file enscript.c.

TManagedClassMap

typedef map<Managed, Class> TManagedClassMap

Definition at line 1013 of file enscript.c.

TManagedFloatMap

typedef map<Managed, float> TManagedFloatMap

Definition at line 1010 of file enscript.c.

TManagedIntMap

typedef map<Managed, int> TManagedIntMap

Definition at line 1011 of file enscript.c.

TManagedManagedMap

typedef map<Managed, Managed> TManagedManagedMap

Definition at line 1014 of file enscript.c.

TManagedManagedRefMap

typedef map<Managed, ref Managed> TManagedManagedRefMap

Definition at line 1015 of file enscript.c.

TManagedRefArray

typedef array<ref Managed> TManagedRefArray

Definition at line 718 of file enscript.c.

TManagedRefClassMap

typedef map<ref Managed, Class> TManagedRefClassMap

Definition at line 1022 of file enscript.c.

TManagedRefFloatMap

typedef map<ref Managed, float> TManagedRefFloatMap

Definition at line 1019 of file enscript.c.

TManagedRefIntMap

typedef map<ref Managed, int> TManagedRefIntMap

Definition at line 1020 of file enscript.c.

TManagedRefManagedMap

typedef map<ref Managed, Managed> TManagedRefManagedMap

Definition at line 1023 of file enscript.c.

TManagedRefManagedRefMap

typedef map<ref Managed, ref Managed> TManagedRefManagedRefMap

Definition at line 1024 of file enscript.c.

TManagedRefSet

typedef set<ref Managed> TManagedRefSet

Definition at line 807 of file enscript.c.

TManagedRefStringMap

typedef map<ref Managed, string> TManagedRefStringMap

Definition at line 1021 of file enscript.c.

TManagedRefTypenameMap

typedef map<ref Managed, typename> TManagedRefTypenameMap

Definition at line 1025 of file enscript.c.

TManagedRefVectorMap

typedef map<ref Managed, vector> TManagedRefVectorMap

Definition at line 1026 of file enscript.c.

TManagedSet

typedef set<Managed> TManagedSet

Definition at line 806 of file enscript.c.

TManagedStringMap

typedef map<Managed, string> TManagedStringMap

Definition at line 1012 of file enscript.c.

TManagedTypenameMap

typedef map<Managed, typename> TManagedTypenameMap

Definition at line 1016 of file enscript.c.

TManagedVectorMap

typedef map<Managed, vector> TManagedVectorMap

Definition at line 1017 of file enscript.c.

TStringArray

typedef array<string> TStringArray

Definition at line 712 of file enscript.c.

TStringClassMap

typedef map<string, Class> TStringClassMap

Definition at line 986 of file enscript.c.

TStringFloatMap

typedef map<string, float> TStringFloatMap

Definition at line 983 of file enscript.c.

TStringIntMap

typedef map<string, int> TStringIntMap

Definition at line 984 of file enscript.c.

TStringManagedMap

typedef map<string, Managed> TStringManagedMap

Definition at line 987 of file enscript.c.

TStringManagedRefMap

typedef map<string, ref Managed> TStringManagedRefMap

Definition at line 988 of file enscript.c.

TStringSet

typedef set<string> TStringSet

Definition at line 802 of file enscript.c.

TStringStringMap

typedef map<string, string> TStringStringMap

Definition at line 985 of file enscript.c.

TStringTypenameMap

typedef map<string, typename> TStringTypenameMap

Definition at line 989 of file enscript.c.

TStringVectorMap

typedef map<string, vector> TStringVectorMap

Definition at line 990 of file enscript.c.

TTypenameArray

typedef array<typename> TTypenameArray

Definition at line 720 of file enscript.c.

TTypeNameClassMap

typedef map<typename, Class> TTypeNameClassMap

Definition at line 1004 of file enscript.c.

TTypeNameFloatMap

typedef map<typename, float> TTypeNameFloatMap

Definition at line 1001 of file enscript.c.

TTypeNameIntMap

typedef map<typename, int> TTypeNameIntMap

Definition at line 1002 of file enscript.c.

TTypeNameManagedMap

typedef map<typename, Managed> TTypeNameManagedMap

Definition at line 1005 of file enscript.c.

TTypeNameManagedRefMap

typedef map<typename, ref Managed> TTypeNameManagedRefMap

Definition at line 1006 of file enscript.c.

TTypenameSet

typedef set<typename> TTypenameSet

Definition at line 808 of file enscript.c.

TTypeNameStringMap

typedef map<typename, string> TTypeNameStringMap

Definition at line 1003 of file enscript.c.

TTypeNameTypenameMap

typedef map<typename, typename> TTypeNameTypenameMap

Definition at line 1007 of file enscript.c.

TTypeNameVectorMap

typedef map<typename, vector> TTypeNameVectorMap

Definition at line 1008 of file enscript.c.

TVectorArray

typedef array<vector> TVectorArray

Definition at line 719 of file enscript.c.

TypeID

typedef int [] TypeID

script representation for C++ RTTI types

Definition at line 127 of file enscript.c.

Function Documentation

EnScript()

void EnScript ( )

inlineprivate

Definition at line 168 of file enscript.c.

Obsolete() [1/2]

void Obsolete ( string msg = "" )

inlineprivate

Definition at line 362 of file enscript.c.

References m_Msg.

~EnScript()

void ~EnScript ( )

inlineprivate

Definition at line 169 of file enscript.c.

~ScriptModule()

void ~ScriptModule ( )

private

Begin()

proto native MapIterator Begin ( )

private

Call()

proto volatile int Call ( Class inst, string function, void parm )

private

dynamic call of function when inst == NULL, it's global function call, otherwise it's method of class returns true, when success The call creates new thread, so it's legal to use sleep/wait

CallFunction()

proto volatile int CallFunction ( Class inst, string function, out void returnVal, void parm )

private

dynamic call of function when inst == NULL, it's global function call, otherwise it's method of class returns true, when success The call do not create new thread!

!!!

CallFunctionParams()

proto volatile int CallFunctionParams ( Class inst, string function, out void returnVal, Class parms )

private

Cast()

proto Class Cast ( Class from )

staticprivate

Try to safely down-cast base class to child class.

Returns

down-casted 'from' pointer when cast is successfull (classes are related), or null if casting is invalid

// assume that Man inheites from Object
Object obj = g_Game.GetPlayer();
Man player = Man.Cast(obj);
 
if (player)
{
    // horay!
}

CastTo()

proto bool CastTo ( out Class to, Class from )

staticprivate

Try to safely down-cast base class to child class.

Returns

bool true when 'from' is not null and cast successfull, false when casting is not valid or 'from' is null

// assume that Man inheites from Object
Object obj = g_Game.GetPlayer();
Man player;
 
if (Class.CastTo(player, obj))
{
    // horay!
}

Referenced by ConnectionLost::ConnectionLost(), DamageDealtEffect::DamageDealtEffect(), DayZIntroScene::DayZIntroScene(), DayZPlayerImplementAiming::DayZPlayerImplementAiming(), FlashbangEffect::FlashbangEffect(), AbortWeaponEvent(), ActionAnimateCarSelection::ActionCondition(), ActionAnimateSeats::ActionCondition(), ActionBuryBody::ActionCondition(), ActionCarDoors::ActionCondition(), ActionCarDoorsOutside::ActionCondition(), ActionCarHornBase::ActionCondition(), ActionClapBearTrapWithThisItem::ActionCondition(), ActionCloseDoors::ActionCondition(), ActionCondition(), ActionCoverHeadTarget::ActionCondition(), ActionDefibrilateBase::ActionCondition(), ActionDigGardenPlot::ActionCondition(), ActionDigInStash::ActionCondition(), ActionDisinfectPlant::ActionCondition(), ActionEatFruit::ActionCondition(), ActionEnterLadder::ActionCondition(), ActionFillGeneratorTank::ActionCondition(), ActionFillObject::ActionCondition(), ActionGagTarget::ActionCondition(), ActionGetInTransport::ActionCondition(), ActionHarvestCrops::ActionCondition(), ActionLockDoors::ActionCondition(), ActionLockedDoors::ActionCondition(), ActionOpen::ActionCondition(), ActionOpenDoors::ActionCondition(), ActionPickupChicken::ActionCondition(), ActionRefuelTorch::ActionCondition(), ActionRemovePlant::ActionCondition(), ActionRemoveSeed::ActionCondition(), ActionRepairShelter::ActionCondition(), ActionRepairTent::ActionCondition(), ActionRepairTentPart::ActionCondition(), ActionShaveTarget::ActionCondition(), ActionSwitchLights::ActionCondition(), ActionSwitchSeats::ActionCondition(), ActionToggleNVMode::ActionCondition(), ActionUncoverHeadTarget::ActionCondition(), ActionUngagTarget::ActionCondition(), ActionUnlockDoors::ActionCondition(), ActionUnlockShippingContainer::ActionCondition(), ActionViewBinoculars::ActionCondition(), ActionViewOptics::ActionCondition(), ActionZoomIn::ActionCondition(), ActionZoomOut::ActionCondition(), ActionWorldCraft::ActionConditionContinue(), CatchingContextTrapsBase::AdjustBaitItemChance(), UIScriptedMenu::Apply(), ApplyDrynessToItemEx(), ActionGetOutTransport::ApplyJumpOutDmg(), ApplyWetnessToItem(), ManBase::BrokenLegForceProne(), ButtonHighlight(), ButtonNormal(), CAContinuousEmptyMagazine::CalcAndSetQuantity(), CAContinuousTransferQuantity::CalcAndSetQuantity(), PluginBase::CalculateHealth(), ManBase::CalculateVisibilityForAI(), DayZPlayer::CameraHandler(), WeaponManager::CanAttachMagazine(), DayZPlayer::CanClimb(), Attachments::CanCombineAmmo(), VicinitySlotsContainer::CanCombineAmmo(), AttachmentCategoriesContainer::CanDisplayAnyCategory(), RecipeBase::CanDo(), RepairWithLeatherSewingKit::CanDo(), RepairWithSewingKit::CanDo(), RepairWithTireKit::CanDo(), ActionEmptyMagazine::CanEmpty(), ItemBase::CanLoadAttachment(), ActionLoadMagazine::CanLoadMagazine(), UIScriptedMenu::CanOpenMenu(), CanPlayEmote(), ItemBase::CanReceiveAttachment(), WeaponManager::CanSwapMagazine(), TrapBase::CauseVictimToStartLimping(), ScriptedWidgetEventHandler::CheckForActionWidgetOverrides(), ManBase::CheckForBurlap(), ManBase::CheckForGag(), ScriptedWidgetEventHandler::ColorRed(), ScriptedWidgetEventHandler::ColorWhite(), BreakLongWoodenStick::CopyOldPropertiesToNew(), CopyOldPropertiesToNew(), TorchLambda::CopyOldPropertiesToNew(), UnboxLambda::CopyOldPropertiesToNew(), ActionFishingNewCB::CreateActionComponent(), ActionFishingNew::CreateAndSetupActionCallback(), ActionRepositionPluggedItem::CreateAndSetupActionCallback(), ActionTakeArrowToHands::CreateAndSetupActionCallback(), ActionTakeHybridAttachmentToHands::CreateAndSetupActionCallback(), ActionTakeItemToHands::CreateAndSetupActionCallback(), ActionTakeMaterialToHands::CreateAndSetupActionCallback(), AnimatedActionBase::CreateAndSetupActionCallback(), CreateAndSetupActionCallback(), MissionBase::CreateCharacter(), PlayerSpawnHandler::CreateChildItem(), CreateDamageTriggerEx(), CreateEmoteCallback(), CreateOrgan(), Car::CreateSoundForAnimationSource(), CreateTrigger(), Hologram::CreateTrigger(), Car::DamageCrew(), DayZPlayerCameraBase::DayZPlayerCameraIronsights(), InventoryActionHandler::DeactiveAction(), DeferredWeaponFailed(), ActionDefibrilateBase::DefibrillateServer(), StaminaHandler::DepleteStaminaEx(), CatchingContextFishingBase::DeserializeData(), CatchingContextTrapsBase::DeserializeData(), ActionDismantlePart::DismantleCondition(), Hud::DisplayBadge(), Hud::DisplayNotifier(), Hud::DisplayPresence(), Hud::DisplayStance(), Hud::DisplayTendencyNormal(), RecipeBase::Do(), RepairWithLeatherSewingKit::Do(), RepairWithSewingKit::Do(), RepairWithTireKit::Do(), ClosableContainer::DraggingOverHeader(), WeaponDebug::DrawLineOfFireCameraHybrid(), WeaponDebug::DrawLineOfFireMuzzleToHit(), ManBase::DropAllItems(), ActionDeployBase::DropDuringPlacing(), ManBase::EEItemIntoHands(), Mask_Base::EEItemLocationChanged(), ManBase::EEItemOutOfHands(), InventoryItemSuper::EEKilled(), EffectRadial(), Trigger::EOnEnter(), Trigger::EOnLeave(), AreaDamageTriggerBase::EOnTouch(), Hologram::EvaluateCollision(), ActionFishingNew::EvaluateFishingResult(), VicinityItemManager::ExcludeFromContainer_Phase1(), VicinityItemManager::ExcludeFromContainer_Phase2(), VicinityItemManager::ExcludeFromContainer_Phase3(), CAContinuousCraft::Execute(), CAContinuousFertilizeGardenSlot::Execute(), CAContinuousMineWood::Execute(), CAContinuousRepeatStartEngine::Execute(), CAContinuousTransferQuantity::Execute(), CAContinuousWaterPlant::Execute(), FloatingCrossHair(), GameplayEffectsDataImage(), CatchingContextFishingRodAction::GenerateResult(), GenerateResult(), GestureMenuItem(), ActionTargetsCursor::GetActionManager(), GetActionManager(), ScriptedWidgetEventHandler::GetActionManager(), FishingRod_Base_New::GetActionWidgetOverride(), ActionMountBarbedWire::GetBarbedWire(), CarScript::GetCarDoorsState(), HandsContainer::GetCombinationFlags(), ItemManager::GetCombinationFlags(), ScriptedWidgetEventHandler::GetCrosshairPosition(), ActionTargetsCursor::GetItemCargoCount(), ActionTargetsCursor::GetItemHealth(), ActionTargetsCursor::GetItemQuantity(), QuantityConversions::GetItemQuantity(), QuantityConversions::GetItemQuantity(), QuantityConversions::GetItemQuantityMax(), QuantityConversions::GetItemQuantityText(), GetLocalProperties(), GetMeleeTarget(), CAContinuousMineRock::GetMiningData(), CAContinuousMineWood::GetMiningData(), InventoryItem::GetNumberOfItems(), ActionHarvestCrops::GetPlantSlot(), ActionTargetsCursor::GetPlayer(), GetPlayer(), ScriptedWidgetEventHandler::GetPlayer(), DeveloperTeleport::GetPlayerRootForTeleporting(), ScriptedWidgetEventHandler::GetRadioFrequency(), Managed::GetRequester(), ActionWorldCraft::GetText(), CGame::GetUserFOVFromConfig(), WeaponDebug::GetWeaponInHands(), BotGuardBase::GuardCondition(), HandEventBase(), HeadGear_Base::HandleAttachedToHead(), DayZPlayer::HandleDeath(), BaseBuildingBase::HandleDropAttachment(), HandleDropCartridge(), Car::HandleEngineSound(), HandleInventory(), PlayerSpawnHandler::HandleNewItem(), HandlePlayerBody(), HandleStoreCartridge(), HandleWeaponEvents(), DayZPlayer::HandleWeapons(), QuantityConversions::HasItemQuantity(), Hud::Init(), Init(), ScriptedWidgetEventHandler::Init(), UIScriptedMenu::Init(), Hud::InitBadgesAndNotifiers(), PPEMatClassParameterCommandData::InitDefaults(), IsAuthoritative(), IsEntityBehindEntityInAngle(), EntityAI::IsIgnoredObject(), HumanCommandVehicle::IsObjectIgnoredOnGettingOut(), IsOwner(), IsProxy(), VONManager::IsVoiceThresholdMinimum(), ActionUncoverHeadTarget::IsWearingBurlap(), IsWearingBurlap(), ActionUngagSelf::IsWearingGag(), ActionUngagTarget::IsWearingGag(), ManBase::IsWearingSplint(), ItemBase::ItemFall(), LoadingScreen(), ActionLockDoors::LockDoor(), UIScriptedMenu::MarkSelected(), DayZCreature::ModCommandHandlerBefore(), ModifierBase(), ActionWorldCraft::OnActionInfoUpdate(), ActionContinuousBase::OnAnimationEvent(), AKS74U::OnDebugSpawn(), Aug_Base::OnDebugSpawn(), B95_base::OnDebugSpawn(), CarScript::OnDebugSpawn(), CivilianBelt::OnDebugSpawn(), Container_Base::OnDebugSpawn(), CZ550_Base::OnDebugSpawn(), Derringer_Base::OnDebugSpawn(), FishingRod_Base_New::OnDebugSpawn(), Flaregun::OnDebugSpawn(), HelmetBase::OnDebugSpawn(), HipPack_ColorBase::OnDebugSpawn(), ItemBase::OnDebugSpawn(), Izh43Shotgun_Base::OnDebugSpawn(), LongHorn_Base::OnDebugSpawn(), MilitaryBelt::OnDebugSpawn(), Mosin9130_Base::OnDebugSpawn(), Mp133Shotgun_Base::OnDebugSpawn(), PlateCarrierVest::OnDebugSpawn(), R12_Base::OnDebugSpawn(), Repeater::OnDebugSpawn(), Rifle_Base::OnDebugSpawn(), RifleSingleShot_Base::OnDebugSpawn(), RifleSingleShotManual_Base::OnDebugSpawn(), VSS_Base::OnDebugSpawn(), Weapon_Base::OnDebugSpawn(), Winchester70_Base::OnDebugSpawn(), AttachmentCategoriesRow::OnDropReceivedFromHeader(), ActionFishingNew::OnEnd(), ActionViewOptics::OnEndAnimationLoopClient(), ActionViewOptics::OnEndAnimationLoopServer(), ActionViewOptics::OnEndClient(), ActionCarHornLong::OnEndInput(), ActionContinuousBase::OnEndInput(), ActionFishingNew::OnEndInput(), ActionAnimateCarSelection::OnEndServer(), ActionCollectBloodSelf::OnEndServer(), ActionCollectBloodTarget::OnEndServer(), ActionCollectSampleSelf::OnEndServer(), ActionCollectSampleTarget::OnEndServer(), ActionViewOptics::OnEndServer(), ActionZoomIn::OnEndServer(), ActionZoomOut::OnEndServer(), OnEntry(), WeaponFire::OnEntry(), WeaponStartAction::OnEntry(), WeaponStateBase::OnEntry(), CGame::OnEvent(), MissionBase::OnEvent(), OnEvent(), ActionLockedDoors::OnExecute(), ActionAttachWheels::OnExecuteClient(), ActionAttachWheels::OnExecuteServer(), ActionClapBearTrapWithThisItem::OnExecuteServer(), ActionEmptyMagazine::OnExecuteServer(), ActionLoadMagazine::OnExecuteServer(), ActionRefuelTorch::OnExecuteServer(), ActionSwitchLights::OnExecuteServer(), WeaponStartAction::OnExit(), ActionFishingNew::OnFinishProgress(), ActionDefibrilateSelf::OnFinishProgressClient(), ActionDefibrilateTarget::OnFinishProgressClient(), ActionFillObject::OnFinishProgressClient(), ActionBreakLongWoodenStick::OnFinishProgressServer(), ActionCoverHeadSelf::OnFinishProgressServer(), ActionCoverHeadTarget::OnFinishProgressServer(), ActionDefibrilateSelf::OnFinishProgressServer(), ActionFillObject::OnFinishProgressServer(), ActionGagSelf::OnFinishProgressServer(), ActionGagTarget::OnFinishProgressServer(), ActionRepairPart::OnFinishProgressServer(), ActionRepairShelter::OnFinishProgressServer(), ActionRepairTent::OnFinishProgressServer(), ActionShaveTarget::OnFinishProgressServer(), ActionStripCarrierVest::OnFinishProgressServer(), ActionUngagSelf::OnFinishProgressServer(), ActionUngagTarget::OnFinishProgressServer(), ActionWorldCraft::OnFinishProgressServer(), OnFinishProgressServer(), Barrel_ColorBase::OnFreezeStateChangeServer(), OnFreezeStateChangeServer(), SymptomBase::OnInit(), ItemBase::OnInventoryEnter(), DummyItem::OnItemLocationChanged(), Weapon::OnItemLocationChanged(), HandsContainer::OnPerformCombination(), Icon::OnPerformCombination(), EntityPlacementCallback::OnQuery(), ManBase::OnQuickBarSingleUse(), TrapBase::OnServerSteppedOn(), EntityPlacementCallback::OnSetup(), OnShow(), ActionFishingNew::OnSignalEnd(), CAContinuousRepeatFishing::OnSignalEnd(), ActionFishingNew::OnSignalStart(), CAContinuousRepeatFishing::OnSignalStart(), ActionSwitchSeats::OnStart(), ActionViewOptics::OnStartAnimationLoopClient(), ActionViewOptics::OnStartAnimationLoopServer(), ActionAnimateCarSelection::OnStartServer(), ActionCloseDoors::OnStartServer(), ActionGetOutTransport::OnStartServer(), ActionOpenDoors::OnStartServer(), ActionPullBodyFromTransport::OnStartServer(), PPERequester_GameplayBase::OnStop(), InventoryItem::OnStoreLoad(), UngagSelfLambda::OnSuccess(), OnUpdate(), WeaponFireMultiMuzzle::OnUpdate(), WeaponStartAction::OnUpdate(), WeaponStateBase::OnUpdate(), Car::OnVehicleJumpOutServer(), ItemBase::OnWasAttached(), ItemOptics::OnWasAttached(), ItemBase::OnWasDetached(), ItemOptics::OnWasDetached(), Icon::PerformCombination(), Hologram::PlaceEntity(), ManBase::PredictiveSwapEntities(), ProcessItemHierarchyRecursive(), DayZPlayer::ProcessWeaponEvent(), RandomizeSignalValues(), ActionFishingNew::ReadFromContext(), VicinityItemManager::RefreshVicinityItems(), GameplayEffectsData::RegisterData(), PPEClassBase::RegisterParameterColorEx(), PPEClassBase::RegisterParameterScalarFloatEx(), ManBase::ReloadWeapon(), ManBase::RemoveAllItems(), ItemBase::RemoveCookingAudioVisuals(), RemoveSplint(), ActionRepairTent::RepairDamageTransfer(), CatchingResultBase::RollChanceSeeded(), RollNextResultChance(), SelectStoreCartridge(), ActionBase::SendMessageToClient(), InventoryActionHandler::SetAction(), ActionTargetsCursor::SetActionWidget(), ScriptedWidgetEventHandler::SetActionWidget(), Weapon_Base::SetAttachmentsHealth(), ManBase::SetContaminatedEffectEx(), DayZIntroScenePC::SetInitPostprocesses(), DayZIntroSceneXbox::SetInitPostprocesses(), ActionTargetsCursor::SetInteractActionIcon(), ScriptedWidgetEventHandler::SetInteractActionIcon(), ActionTargetsCursor::SetItemDesc(), ScriptedWidgetEventHandler::SetItemDesc(), ActionTargetsCursor::SetItemHealth(), ScriptedWidgetEventHandler::SetItemHealth(), ActionTargetsCursor::SetItemQuantity(), ScriptedWidgetEventHandler::SetItemQuantity(), ScriptedWidgetEventHandler::SetRadioFrequency(), Hud::SetStamina(), CAContinuousCraft::Setup(), CAContinuousDisinfectPlant::Setup(), CAContinuousEmptyMagazine::Setup(), CAContinuousFertilizeGardenSlot::Setup(), CAContinuousFill::Setup(), CAContinuousFish::Setup(), CAContinuousLoadMagazine::Setup(), CAContinuousTransferQuantity::Setup(), CAContinuousWaterPlant::Setup(), CAContinuousWaterSlot::Setup(), ActionFishingNew::SetupAction(), ActionWorldCraft::SetupAction(), ScriptedWidgetEventHandler::SetValue(), Hud::SetWalkieTalkieText(), ScriptedWidgetEventHandler::SetWeaponModeAndZeroing(), ScriptedWidgetEventHandler::SetWeaponQuantity(), SoftSkillManagerDebug(), ActionSortAmmoPile::SortAmmo(), Car::SpawnAdditionalItems(), CarchingResultFishingAction::SpawnAndSetup(), CatchingResultTrapBase::SpawnAndSetup(), PlayerSpawnHandler::SpawnComplexChildrenItems(), PluginBase::SpawnEntityOnCursorDir(), PluginBase::SpawnEntityOnGroundPatternGrid(), PluginBase::SpawnEntityOnGroundPos(), PlayerSpawnHandler::SpawnSimpleChildrenItems(), ActionEnterLadder::Start(), StopCooling(), SwitchPreset(), SyncAnimState(), ClosableContainer::TakeAsAttachment(), HandsContainer::TakeAsAttachment(), DeveloperTeleport::TeleportAtCursor(), DeveloperTeleport::TeleportAtCursorEx(), ScriptedWidgetEventHandler::TextMapUpdateWidget(), PluginDayzPlayerDebug_Weapons::Tick(), TransferEntityVariables(), ActionUnlockShippingContainer::TranslateLockSelectionIntoDoorIdx(), DayZPlayer::TriggerPullPlayerOutOfVehicle(), Managed::TrySpawnNextDrop(), ActionUncoverHeadBase::UncoverHead(), ActionUnlockDoors::UnlockDoor(), ActionUnlockShippingContainer::UnlockDoor(), GameplayEffectsData::Update(), Hud::UpdateBloodName(), UIScriptedMenu::UpdateItemInfoQuantity(), MissionBase::UpdatePlayersStats(), UniversalTemperatureSourceLambdaBaseImpl::UpdateVicinityTemperatureRecursive(), UniversalTemperatureSourceLambdaBaseImpl::WarmAndCoolItemsInVicinity(), ActionFishingNew::WriteToContext(), ActionMountBarbedWire::WriteToContext(), ActionRepairCarPart::WriteToContext(), ActionRepairPart::WriteToContext(), ActionRepairTent::WriteToContext(), ActionRepairTentPart::WriteToContext(), and ActionRepairVehiclePartBase::WriteToContext().

ClassName()

proto native owned external string ClassName ( )

private

Returns name of class-type.

Parameters

inst

Class

Returns

string class-type

Man player = g_Game.GetPlayer();
string className = player.ClassName();
Print(className);
 
>> className = 'Man'

Referenced by GetDebugName().

Clear() [1/3]

proto native void Clear ( )

private

Destroyes all elements of the array and sets the Count to 0.

The underlying memory of the array is not freed.

Clear() [2/3]

proto native void Clear ( )

private

Clears the hash map.

Clear() [3/3]

proto native void Clear ( )

private

Contains()

proto bool Contains ( TKey key )

private

Returns if map contains element with given key.

Referenced by ReplaceKey().

Copy() [1/3]

proto int Copy ( notnull array< T > from )

private

Copes contents of from array to this array.

Returns

How many elements were copied

Copy() [2/3]

proto int Copy ( map< TKey, TValue > from )

private

Copy() [3/3]

proto int Copy ( set< T > from )

private

copyarray()

proto void copyarray	(	void	destArray,
		void	srcArray )

Count() [1/3]

proto native int Count ( )

private

O(1) complexity.

Returns

Number of elements of the array

Count() [2/3]

proto native int Count ( )

private

Returns

The number of elements in the hashmap.

Count() [3/3]

proto native int Count ( )

private

Debug() [1/2]

void Debug ( )

inlineprivate

Print all elements in array.

Returns

void

my_array.Debug();
 
>> "One"
>> "Two"
>> "Three"

Definition at line 548 of file enscript.c.

References Count, Get(), and Print().

Debug() [2/2]

void Debug ( )

inlineprivate

Definition at line 790 of file enscript.c.

References Count, Get(), and Print().

DifferentAtPosition()

int DifferentAtPosition ( array< T > pOtherArray )

inlineprivate

Returns an index where 2 arrays start to differ from each other.

Returns

int Index from where arrays differ

array<int> arr1 = {0,1,2,3};
array<int> arr2 = {0,1,3,2};
int differsAt = arr1.DifferentAtPosition(arr2);
Print(differsAt);
 
>> 2

Definition at line 690 of file enscript.c.

References Count, ErrorEx, and Get().

End()

proto native MapIterator End ( )

private

Find() [1/3]

proto int Find ( T value )

private

Tries to find the first occurance of given value in the array.

Returns

Index of the first occurance of value if found, -1 otherwise

Referenced by RemoveItem(), and RemoveItemUnOrdered().

Find() [2/3]

proto bool Find ( TKey key, out TValue val )

private

Search for an element with the given key.

Parameters

key	The key of the element to find
val	result is stored to val

Returns

returns True if given key exist.

Find() [3/3]

proto int Find ( T value )

private

Tries to find the first occurance of given value in the set.

Returns

Index of the first occurance of value if found, -1 otherwise

Referenced by RemoveItem().

Get() [1/3]

proto T Get ( int n )

private

Returns

Element at the index n

Get() [2/3]

proto TValue Get ( TKey key )

private

Search for an element with the given key.

Parameters

key	The key of the element to find

Returns

Pointer to element data if found, NULL otherwise.

Get() [3/3]

proto T Get ( int n )

private

GetClassVar()

proto int GetClassVar ( Class inst, string varname, int index, out void result )

staticprivate

Dynamic read of variable value by its name.

Parameters

	inst	When inst == NULL, it's for global variable, otherwise it's class member
	index	Is index when variable is array
[out]	result	Variable must be of the same type!

Returns

int true when success

float count = 0;
 
bool success = EnScript.GetClassVar(myClass, "m_Counter", 0, count);
Print(count);
Print(success);
 
>> count = 5
>> success = 1

GetDebugName()

string GetDebugName ( )

inlineprivate

Definition at line 39 of file enscript.c.

References ClassName().

GetElement()

proto TValue GetElement ( int index )

private

Return the i:th element in the map.

Note: This operation is O(n) complexity. Use with care!

Parameters

index

The position of the element in the map

Returns

The element on the i:th position

Referenced by GetValueArray().

GetIteratorElement()

proto TValue GetIteratorElement ( MapIterator it )

private

GetIteratorKey()

proto TKey GetIteratorKey ( MapIterator it )

private

GetKey()

proto TKey GetKey ( int i )

private

Return the i:th element key in the map.

Note: This operation is O(n) complexity. Use with care!

Parameters

i	The position of the element key in the map

Returns

Return key of i-th element

Referenced by GetKeyArray(), GetKeyByValue(), and GetKeyByValueChecked().

GetKeyArray()

array< TKey > GetKeyArray ( )

inlineprivate

Definition at line 910 of file enscript.c.

References Count, and GetKey().

GetKeyByValue()

TKey GetKeyByValue ( TValue value )

inlineprivate

Definition at line 939 of file enscript.c.

References Count, GetElement(), and GetKey().

GetKeyByValueChecked()

bool GetKeyByValueChecked ( TValue value, out TKey key )

inlineprivate

Definition at line 954 of file enscript.c.

References Count, GetElement(), and GetKey().

GetRandomElement()

T GetRandomElement ( )

inlineprivate

Returns a random element of array.

Returns

int Random element of array

Print( my_array.GetRandomElement() );
 
>> "Three"

Definition at line 586 of file enscript.c.

References Get(), and GetRandomIndex().

GetRandomIndex()

int GetRandomIndex ( )

inlineprivate

Returns a random index of array.

If Count is 0, return index is -1 .

Returns

int Random index of array

Print( my_array.GetRandomIndex() );
 
>> 2

Definition at line 567 of file enscript.c.

References Count, and Math::RandomInt().

Referenced by GetRandomElement(), and ShuffleArray().

GetValueArray()

array< TValue > GetValueArray ( )

inlineprivate

Definition at line 919 of file enscript.c.

References Count, and GetElement().

Idle()

proto volatile void Idle

(

)

Yiels execution to other threads and then it continues.

Obsolete...

Init() [1/2]

proto int Init ( T init[] )

private

References init.

Init() [2/2]

proto int Init ( T init[] )

private

References init.

Insert() [1/3]

proto int Insert ( T value )

private

Inserts element at the end of array.

Parameters

value

Element to be inserted

Returns

Position at which element is inserted

Referenced by InsertAll(), and InsertArray().

Insert() [2/3]

proto bool Insert ( TKey key, TValue value )

private

Insert new element into hash map.

Parameters

key	Key of element to be inserted.
value	Data of element to be inserted.

Insert() [3/3]

proto int Insert ( T value )

private

Inserts element at the end of array.

Parameters

value

Element to be inserted

Returns

Position at which element is inserted

Referenced by InsertSet().

InsertAll()

void InsertAll ( notnull array< T > from )

inlineprivate

Inserts all elements from array.

Parameters

from

array<T> array from which all elements will be added TStringArray arr1 = new TStringArray; arr1.Insert( "Dave" ); arr1.Insert( "Mark" ); arr1.Insert( "John" ); TStringArray arr2 = new TStringArray; arr2.Insert( "Sarah" ); arr2.Insert( "Cate" ); arr1.InsertAll(arr2); for ( int i = 0; i < arr1.Count(); i++ ) { Print( arr1.Get(i) ); } delete arr2; delete arr1; >> "Dave" >> "Mark" >> "John" >> "Sarah" >> "Cate"

Definition at line 449 of file enscript.c.

References Insert().

InsertArray()

void InsertArray ( array< T > other )

inlineprivate

Definition at line 598 of file enscript.c.

References Insert().

InsertAt() [1/2]

proto int InsertAt ( T value, int index )

private

Inserts element at certain position and moves all elements behind this position by one.

Parameters

value	Element to be inserted
index	Position at which element is inserted. Must be less than Array::GetCardinality()

Returns

Number of elements after insertion

InsertAt() [2/2]

proto int InsertAt ( T value, int index )

private

Inserts element at certain position and moves all elements behind this position by one.

Parameters

value	Element to be inserted
index	Position at which element is inserted. Must be less than Array::GetCardinality()

Returns

Number of elements after insertion

InsertSet()

void InsertSet ( set< T > other )

inlineprivate

Definition at line 761 of file enscript.c.

References Insert().

Invert()

void Invert ( )

inlineprivate

Definition at line 608 of file enscript.c.

References Count, Get(), and Set().

IsInherited()

proto native external bool IsInherited ( typename type )

private

Returns true when instance is of the type, or inherited one.

Parameters

type	Class type

Returns

bool true when 'clType' is the same as 'type', or inherited one.

if (inst && inst.IsInherited(Widget))
{
    Print("inst is inherited from Widget class!");      
}

IsValidIndex()

bool IsValidIndex ( int index )

inlineprivate

Definition at line 522 of file enscript.c.

References Count.

KillThread()

proto native int KillThread	(	Class	owner,
		string	name )

Kills thread.

Parameters

owner	Can be NULL for global threads.
name	Name of the first function on stack

Returns

int ???

???

References name.

LoadScript()

proto native ScriptModule LoadScript ( ScriptModule parentModule, string scriptFile, bool listing )

staticprivate

Do load script and create ScriptModule for it.

Parameters

parentModule	Module
scriptFile	Script path
listing	??

Returns

ScriptModule Loaded scripted module

???

MoveIndex()

int MoveIndex ( int curr_index, int move_number )

inlineprivate

Returns a index in array moved by specific number.

Returns

int Moved index in this array

Print( "Count: "+ my_array.Count() );
Print( "Moved 1:"+ my_array.MoveIndex(2, 1) );
Print( "Moved 3:"+ my_array.MoveIndex(2, 2) );
 
>> "Count: 4"
>> "Moved index 2 by 1: 3";
>> "Moved index 2 by 2: 0";

Definition at line 636 of file enscript.c.

References Count.

Next()

proto native MapIterator Next ( MapIterator it )

private

Obsolete() [2/2]

void Obsolete

(

string

msg = ""

)

Definition at line 371 of file enscript.c.

ParseString()

proto int ParseString	(	string	input,
		out string	tokens[] )

Parses string into array of tokens returns number of tokens.

Parameters

	input	string String for parse
[out]	tokens	array[] Parsed string in array

Returns

int Number of tokens

string token[2];
int result = ParseString("Hello World", token);
 
for( int i = 0; i < 2; i++ )
{
    Print(token[i]);
}
 
>> 'Hello'
>> 'World'

ParseStringEx()

proto int ParseStringEx	(	inout string	input,
		string	token )

Parses one token from input string.

Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.

Parameters

[in,out]	input	string String for parse\ Output is without founded token
[out]	token	string Founded string token

Returns

int Type of token

Token types:
 0 - error, no token
 1 - defined token (special characters etc. . / * )
 2 - quoted string. Quotes are removed -> TODO
 3 - alphabetic string
 4 - number
 5 - end of line -> TODO

string input = "Hello*World";
string token1;
string token2;
 
int result1 = ParseStringEx(input, token1);
int result2 = ParseStringEx(input, token2);
 
Print( String( "Token1 = '" + token1 + "' Type = " + result1.ToString() ) );
Print( String( "Token2 = '" + token2 + "' Type = " + result2.ToString() ) );
Print( input );
 
>> 'Toke1 = 'Hello' Type = 3'
>> 'Toke1 = '*' Type = 1'

PrintString()

Obsolete Managed PrintString

(

string

s

)

Helper for printing out string expression. Example: PrintString("Hello " + var);.

Definition at line 339 of file enscript.c.

Release()

proto native void Release ( )

private

Remove() [1/3]

proto native void Remove ( int index )

private

Removes element from array.

The empty position is replaced by last element, so removal is quite fast but do not retain order.

Parameters

index

Index of element to be removed

Remove() [2/3]

proto void Remove ( TKey key )

private

Removes element with given key.

Remove() [3/3]

proto native void Remove ( int index )

private

Removes element from array, but retain all elements ordered.

Parameters

index

Index of element to be removed

RemoveElement()

proto void RemoveElement ( int i )

private

Removes i:th element with given key.

Note: This operation is O(n) complexity. Use with care!

Parameters

i	The position of the element key in the map

RemoveItem() [1/2]

void RemoveItem ( T value )

inlineprivate

Definition at line 502 of file enscript.c.

References Find(), and RemoveOrdered().

RemoveItem() [2/2]

void RemoveItem ( T value )

inlineprivate

Definition at line 771 of file enscript.c.

References Find(), and Remove().

Referenced by RemoveItems().

RemoveItems()

void RemoveItems ( set< T > other )

inlineprivate

Definition at line 780 of file enscript.c.

References RemoveItem().

RemoveItemUnOrdered()

void RemoveItemUnOrdered ( T value )

inlineprivate

Definition at line 512 of file enscript.c.

References Find(), and Remove().

RemoveOrdered()

proto native void RemoveOrdered ( int index )

private

Removes element from array, but retain all elements ordered.

It's slower than Remove

Parameters

index

Index of element to be removed

Referenced by RemoveItem().

ReplaceKey()

bool ReplaceKey ( TKey old_key, TKey new_key )

inlineprivate

Definition at line 928 of file enscript.c.

References Contains(), Get(), Remove(), and Set().

Reserve()

proto native void Reserve ( int newSize )

private

Resizes the array to given size internally.

Is used for optimization purposes when the approx. size is known beforehand

Resize()

proto native void Resize ( int newSize )

private

Resizes the array to given size.

If the newSize is lower than current Count overflowing objects are destroyed. If the newSize is higher than current Count missing elements are initialized to zero (null).

reversearray()

proto void reversearray

(

void

param_array

)

SafeCastType()

proto bool SafeCastType ( Class type, out Class to, Class from )

staticprivate

This function is for internal script usage.

Set() [1/2]

proto void Set ( int n, T value )

private

Sets n-th element to given value.

Set() [2/2]

proto void Set ( TKey key, TValue value )

private

Sets value of element with given key.

If element with key not exists, it is created. Note: creating new elements is faster using Insert function.

SetClassVar()

proto int SetClassVar ( Class inst, string varname, int index, void input )

staticprivate

Dynamic write to variable by its name.

Parameters

inst	when inst == NULL, it's for global variable, otherwise it's class member
varname
index	Is index when variable is array
input	Input variable must be of the same type!

Returns

int Returns true(1) when success

Print(myClass.m_Counter);
 
>> m_Counter = 0
 
bool success = EnScript.SetClassVar(myClass, "m_Counter", 0, 5.0);
 
Print(myClass.m_Counter);
Print(success);
 
>> m_Counter = 5
>> success = 1

SetVar()

proto int SetVar ( out void var, string value )

staticprivate

Sets variable value by value in string.

Parameters

[out]	var
	value

Returns

int

???

ShuffleArray()

void ShuffleArray ( )

inlineprivate

Definition at line 670 of file enscript.c.

References Count, GetRandomIndex(), and SwapItems().

Sort() [1/2]

proto native void Sort ( bool reverse = false )

private

Sorts elements of array, depends on underlaying type.

Sort() [2/2]

proto void Sort	(	void	param_array[],
		int	num )

Sorts static array of integers(ascendically) / floats(ascendically) / strings(alphabetically).

Parameters

param_array	array Array to sort
num	int How many items will be sorted in array

Returns

void

string  arrStr[3] = {"Dog", "Car", "Apple"};
Sort(arrStr, 2)
for ( int x = 0; x < 3; x++ )
{
    Print( arrStr[x] );
}
 
>> 'Car'
>> 'Dog'
>> 'Apple'

Referenced by ActionConstructor::ConstructActions(), and EmoteConstructor::ConstructEmotes().

StaticGetType()

StaticGetType ( typename t )

inlinestaticprivate

Returns typename of class even without a variable or instance.

Returns

typename class-type

typename eAITypename = StaticGetType(EntityAI);

Definition at line 73 of file enscript.c.

StaticType()

proto static external StaticType ( )

staticprivate

Returns typename of object's reference.

Returns

typename class-type

EntityAI e;
Print(e.StaticType());
 
>> 'EntityAI'

String()

string String

(

string

s

)

Helper for passing string expression to functions with void parameter. Example: Print(String("Hello " + var));.

Definition at line 339 of file enscript.c.

Referenced by ScriptConsoleEnfScriptTab::Add(), ScriptConsoleOutputTab::Add(), CalculateLinePointFade(), Hud::DisplayNotifier(), Hud::DisplayTendencyNormal(), Hud::DisplayTendencyTemp(), Hud::InitBadgesAndNotifiers(), ScriptedWidgetEventHandler::Remove(), and ScriptedWidgetEventHandler::Show().

Swap() [1/2]

proto native void Swap ( notnull array< T > other )

private

Swaps the contents of this and other arrays.

Does not involve copying of the elements.

Swap() [2/2]

proto native void Swap ( set< T > other )

private

SwapItems()

void SwapItems ( int item1_index, int item2_index )

inlineprivate

Definition at line 591 of file enscript.c.

References Get(), and Set().

Referenced by ShuffleArray().

ThreadFunction()

proto owned string ThreadFunction	(	Class	owner,
		string	name,
		int	backtrace,
		out int	linenumber )

Debug function.

Returns current function on stack of the thread

Parameters

owner	Can be NULL for global threads
name	Name of the first function on stack
backtrace	???
linenumber	???

Returns

string ???

???

References name.

ToString()

proto external string ToString ( )

private

Type()

proto native external Type ( )

private

Returns typename of object's class.

Returns

typename class-type

Man player = g_Game.GetPlayer();
typename type = player.Type();
Print(type.ToString());
 
>> 'Man'

Watch()

proto void Watch ( void var, int flags )

staticprivate

Debug tool for watching certain variable.

Invokes debugger whenever is variable used

Parameters

var	Certain variable for watching
flags	= 1 means it will break even when not modified

Returns

void

Variable Documentation

m_Msg [1/2]

string m_Msg

Definition at line 370 of file enscript.c.

m_Msg [2/2]

string m_Msg

private

Definition at line 361 of file enscript.c.

Referenced by Obsolete().

PrintString

class array< Class T > PrintString

Referenced by RecoilBase::ApplyMouseOffset(), RemotePlayerDamageDebug::Debug(), StatDebugObject::Debug(), DebugDamage(), WeaponDebug::DrawLineOfFireCameraHybrid(), PluginRecipesManagerBase::GenerateHumanReadableRecipeList(), GetPlugin(), PluginFileHandler::LoadConfigFile(), ScriptedWidgetEventHandler::OnDoubleClick(), ScriptedWidgetEventHandler::OnDrag(), ScriptedWidgetEventHandler::OnDraggingOver(), ScriptedWidgetEventHandler::OnDrop(), ScriptedWidgetEventHandler::OnDropReceived(), ScriptedWidgetEventHandler::OnMouseButtonDown(), ScriptedWidgetEventHandler::OnMouseButtonUp(), ScriptedWidgetEventHandler::OnMouseEnter(), OnRPC(), PluginBase::OnSpawnErrorReport(), PluginRecipesManagerBase::PrintCache(), PluginBase::PrintedDebug(), PrintElements(), HandsContainer::ShowActionMenuCombine(), ManBase::ShowUnconsciousScreen(), and RecoilBase::Update().