ScriptInstance.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908
  1. //
  2. // Copyright (c) 2008-2014 the Urho3D project.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. //
  22. #include "Precompiled.h"
  23. #include "Context.h"
  24. #include "Log.h"
  25. #include "MemoryBuffer.h"
  26. #include "PhysicsEvents.h"
  27. #include "PhysicsWorld.h"
  28. #include "Profiler.h"
  29. #include "ResourceCache.h"
  30. #include "ResourceEvents.h"
  31. #include "Scene.h"
  32. #include "SceneEvents.h"
  33. #include "Script.h"
  34. #include "ScriptFile.h"
  35. #include "ScriptInstance.h"
  36. #include <angelscript.h>
  37. #include "DebugNew.h"
  38. namespace Urho3D
  39. {
  40. static const char* methodDeclarations[] = {
  41. "void Start()",
  42. "void Stop()",
  43. "void DelayedStart()",
  44. "void Update(float)",
  45. "void PostUpdate(float)",
  46. "void FixedUpdate(float)",
  47. "void FixedPostUpdate(float)",
  48. "void Load(Deserializer&)",
  49. "void Save(Serializer&)",
  50. "void ReadNetworkUpdate(Deserializer&)",
  51. "void WriteNetworkUpdate(Serializer&)",
  52. "void ApplyAttributes()",
  53. "void TransformChanged()"
  54. };
  55. ScriptInstance::ScriptInstance(Context* context) :
  56. Component(context),
  57. script_(GetSubsystem<Script>()),
  58. scriptObject_(0),
  59. fixedUpdateFps_(0),
  60. fixedUpdateInterval_(0.0f),
  61. fixedUpdateAcc_(0.0f),
  62. fixedPostUpdateAcc_(0.0f),
  63. subscribed_(false),
  64. subscribedPostFixed_(false)
  65. {
  66. ClearScriptMethods();
  67. ClearScriptAttributes();
  68. }
  69. ScriptInstance::~ScriptInstance()
  70. {
  71. ReleaseObject();
  72. }
  73. void ScriptInstance::RegisterObject(Context* context)
  74. {
  75. context->RegisterFactory<ScriptInstance>(LOGIC_CATEGORY);
  76. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BOOL, "Is Enabled", IsEnabled, SetEnabled, bool, true, AM_DEFAULT);
  77. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Delayed Method Calls", GetDelayedCallsAttr, SetDelayedCallsAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  78. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_RESOURCEREF, "Script File", GetScriptFileAttr, SetScriptFileAttr, ResourceRef, ResourceRef(ScriptFile::GetTypeStatic()), AM_DEFAULT);
  79. REF_ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_STRING, "Class Name", GetClassName, SetClassName, String, String::EMPTY, AM_DEFAULT);
  80. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_INT, "Fixed Update FPS", GetFixedUpdateFps, SetFixedUpdateFps, int, 0, AM_DEFAULT);
  81. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_FLOAT, "Time Accumulator", GetFixedUpdateAccAttr, SetFixedUpdateAccAttr, float, 0.0f, AM_FILE | AM_NOEDIT);
  82. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Data", GetScriptDataAttr, SetScriptDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  83. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Network Data", GetScriptNetworkDataAttr, SetScriptNetworkDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_NET | AM_NOEDIT);
  84. }
  85. void ScriptInstance::OnSetAttribute(const AttributeInfo& attr, const Variant& src)
  86. {
  87. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  88. {
  89. // The component / node to which the ID refers to may not be in the scene yet, and furthermore the ID must go through the
  90. // SceneResolver first. Delay searching for the object to ApplyAttributes
  91. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  92. idAttributes_[attrPtr] = src.GetUInt();
  93. }
  94. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  95. {
  96. Resource*& resourcePtr = *(reinterpret_cast<Resource**>(attr.ptr_));
  97. // Decrease reference count of the old object if any, then increment the new
  98. if (resourcePtr)
  99. resourcePtr->ReleaseRef();
  100. const ResourceRef& ref = src.GetResourceRef();
  101. resourcePtr = GetSubsystem<ResourceCache>()->GetResource(ref.type_, ref.name_);
  102. if (resourcePtr)
  103. resourcePtr->AddRef();
  104. }
  105. else
  106. Serializable::OnSetAttribute(attr, src);
  107. }
  108. void ScriptInstance::OnGetAttribute(const AttributeInfo& attr, Variant& dest) const
  109. {
  110. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  111. // Get ID's for node / component handle attributes
  112. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  113. {
  114. // If a cached ID value has been stored, return it instead of querying from the actual object
  115. // (the object handle is likely null at that point)
  116. HashMap<AttributeInfo*, unsigned>::ConstIterator i = idAttributes_.Find(attrPtr);
  117. if (i != idAttributes_.End())
  118. dest = i->second_;
  119. else if (attr.mode_ & AM_NODEID)
  120. {
  121. Node* node = *(reinterpret_cast<Node**>(attr.ptr_));
  122. unsigned nodeID = node ? node->GetID() : 0;
  123. dest = nodeID;
  124. }
  125. else
  126. {
  127. Component* component = *(reinterpret_cast<Component**>(attr.ptr_));
  128. unsigned componentID = component ? component->GetID() : 0;
  129. dest = componentID;
  130. }
  131. }
  132. else if (attr.type_ == VAR_RESOURCEREF && attr.ptr_)
  133. {
  134. Resource* resource = *(reinterpret_cast<Resource**>(attr.ptr_));
  135. // If resource is non-null get its type and name hash. Otherwise get type from the default value
  136. dest = GetResourceRef(resource, attr.defaultValue_.GetResourceRef().type_);
  137. }
  138. else
  139. Serializable::OnGetAttribute(attr, dest);
  140. }
  141. void ScriptInstance::ApplyAttributes()
  142. {
  143. // Apply node / component ID attributes now (find objects from the scene and assign to the object handles)
  144. for (HashMap<AttributeInfo*, unsigned>::Iterator i = idAttributes_.Begin(); i != idAttributes_.End(); ++i)
  145. {
  146. AttributeInfo& attr = *i->first_;
  147. if (attr.mode_ & AM_NODEID)
  148. {
  149. Node*& nodePtr = *(reinterpret_cast<Node**>(attr.ptr_));
  150. // Decrease reference count of the old object if any, then increment the new
  151. if (nodePtr)
  152. nodePtr->ReleaseRef();
  153. nodePtr = GetScene()->GetNode(i->second_);
  154. if (nodePtr)
  155. nodePtr->AddRef();
  156. }
  157. else if (attr.mode_ & AM_COMPONENTID)
  158. {
  159. Component*& componentPtr = *(reinterpret_cast<Component**>(attr.ptr_));
  160. if (componentPtr)
  161. componentPtr->ReleaseRef();
  162. componentPtr = GetScene()->GetComponent(i->second_);
  163. if (componentPtr)
  164. componentPtr->AddRef();
  165. }
  166. }
  167. idAttributes_.Clear();
  168. if (scriptObject_ && methods_[METHOD_APPLYATTRIBUTES])
  169. scriptFile_->Execute(scriptObject_, methods_[METHOD_APPLYATTRIBUTES]);
  170. }
  171. void ScriptInstance::OnSetEnabled()
  172. {
  173. UpdateEventSubscription();
  174. }
  175. bool ScriptInstance::CreateObject(ScriptFile* scriptFile, const String& className)
  176. {
  177. className_ = String::EMPTY; // Do not create object during SetScriptFile()
  178. SetScriptFile(scriptFile);
  179. SetClassName(className);
  180. return scriptObject_ != 0;
  181. }
  182. void ScriptInstance::SetScriptFile(ScriptFile* scriptFile)
  183. {
  184. if (scriptFile == scriptFile_ && scriptObject_)
  185. return;
  186. ReleaseObject();
  187. // Unsubscribe from the reload event of previous script file (if any), then subscribe to the new
  188. if (scriptFile_)
  189. {
  190. UnsubscribeFromEvent(scriptFile_, E_RELOADSTARTED);
  191. UnsubscribeFromEvent(scriptFile_, E_RELOADFINISHED);
  192. }
  193. if (scriptFile)
  194. {
  195. SubscribeToEvent(scriptFile, E_RELOADSTARTED, HANDLER(ScriptInstance, HandleScriptFileReload));
  196. SubscribeToEvent(scriptFile, E_RELOADFINISHED, HANDLER(ScriptInstance, HandleScriptFileReloadFinished));
  197. }
  198. scriptFile_ = scriptFile;
  199. CreateObject();
  200. MarkNetworkUpdate();
  201. }
  202. void ScriptInstance::SetClassName(const String& className)
  203. {
  204. if (className == className_ && scriptObject_)
  205. return;
  206. ReleaseObject();
  207. className_ = className;
  208. CreateObject();
  209. MarkNetworkUpdate();
  210. }
  211. void ScriptInstance::SetFixedUpdateFps(int fps)
  212. {
  213. fixedUpdateFps_ = Max(fps, 0);
  214. fixedUpdateInterval_ = fixedUpdateFps_ ? (1.0f / fixedUpdateFps_) : 0.0f;
  215. fixedUpdateAcc_ = 0.0f;
  216. fixedPostUpdateAcc_ = 0.0f;
  217. MarkNetworkUpdate();
  218. }
  219. bool ScriptInstance::Execute(const String& declaration, const VariantVector& parameters)
  220. {
  221. if (!scriptObject_)
  222. return false;
  223. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  224. return scriptFile_->Execute(scriptObject_, method, parameters);
  225. }
  226. bool ScriptInstance::Execute(asIScriptFunction* method, const VariantVector& parameters)
  227. {
  228. if (!method || !scriptObject_)
  229. return false;
  230. return scriptFile_->Execute(scriptObject_, method, parameters);
  231. }
  232. void ScriptInstance::DelayedExecute(float delay, bool repeat, const String& declaration, const VariantVector& parameters)
  233. {
  234. if (!scriptObject_)
  235. return;
  236. DelayedCall call;
  237. call.period_ = call.delay_ = Max(delay, 0.0f);
  238. call.repeat_ = repeat;
  239. call.declaration_ = declaration;
  240. call.parameters_ = parameters;
  241. delayedCalls_.Push(call);
  242. // Make sure we are registered to the scene update event, because delayed calls are executed there
  243. if (!subscribed_)
  244. UpdateEventSubscription();
  245. }
  246. void ScriptInstance::ClearDelayedExecute(const String& declaration)
  247. {
  248. if (declaration.Empty())
  249. delayedCalls_.Clear();
  250. else
  251. {
  252. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End();)
  253. {
  254. if (declaration == i->declaration_)
  255. i = delayedCalls_.Erase(i);
  256. else
  257. ++i;
  258. }
  259. }
  260. }
  261. void ScriptInstance::AddEventHandler(StringHash eventType, const String& handlerName)
  262. {
  263. if (!scriptObject_)
  264. return;
  265. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  266. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  267. if (!method)
  268. {
  269. declaration = "void " + handlerName + "()";
  270. method = scriptFile_->GetMethod(scriptObject_, declaration);
  271. if (!method)
  272. {
  273. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  274. return;
  275. }
  276. }
  277. SubscribeToEvent(eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  278. }
  279. void ScriptInstance::AddEventHandler(Object* sender, StringHash eventType, const String& handlerName)
  280. {
  281. if (!scriptObject_)
  282. return;
  283. if (!sender)
  284. {
  285. LOGERROR("Null event sender for event " + String(eventType) + ", handler " + handlerName);
  286. return;
  287. }
  288. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  289. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  290. if (!method)
  291. {
  292. declaration = "void " + handlerName + "()";
  293. method = scriptFile_->GetMethod(scriptObject_, declaration);
  294. if (!method)
  295. {
  296. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  297. return;
  298. }
  299. }
  300. SubscribeToEvent(sender, eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  301. }
  302. void ScriptInstance::RemoveEventHandler(StringHash eventType)
  303. {
  304. UnsubscribeFromEvent(eventType);
  305. }
  306. void ScriptInstance::RemoveEventHandler(Object* sender, StringHash eventType)
  307. {
  308. UnsubscribeFromEvent(sender, eventType);
  309. }
  310. void ScriptInstance::RemoveEventHandlers(Object* sender)
  311. {
  312. UnsubscribeFromEvents(sender);
  313. }
  314. void ScriptInstance::RemoveEventHandlers()
  315. {
  316. UnsubscribeFromAllEventsExcept(PODVector<StringHash>(), true);
  317. }
  318. void ScriptInstance::RemoveEventHandlersExcept(const PODVector<StringHash>& exceptions)
  319. {
  320. UnsubscribeFromAllEventsExcept(exceptions, true);
  321. }
  322. void ScriptInstance::SetScriptFileAttr(ResourceRef value)
  323. {
  324. ResourceCache* cache = GetSubsystem<ResourceCache>();
  325. SetScriptFile(cache->GetResource<ScriptFile>(value.name_));
  326. }
  327. void ScriptInstance::SetDelayedCallsAttr(PODVector<unsigned char> value)
  328. {
  329. MemoryBuffer buf(value);
  330. delayedCalls_.Resize(buf.ReadVLE());
  331. for (Vector<DelayedCall>::Iterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  332. {
  333. i->period_ = buf.ReadFloat();
  334. i->delay_ = buf.ReadFloat();
  335. i->repeat_ = buf.ReadBool();
  336. i->declaration_ = buf.ReadString();
  337. i->parameters_ = buf.ReadVariantVector();
  338. }
  339. if (scriptObject_ && delayedCalls_.Size() && !subscribed_)
  340. UpdateEventSubscription();
  341. }
  342. void ScriptInstance::SetFixedUpdateAccAttr(float value)
  343. {
  344. fixedUpdateAcc_ = value;
  345. fixedPostUpdateAcc_ = value;
  346. }
  347. void ScriptInstance::SetScriptDataAttr(PODVector<unsigned char> data)
  348. {
  349. if (scriptObject_ && methods_[METHOD_LOAD])
  350. {
  351. MemoryBuffer buf(data);
  352. VariantVector parameters;
  353. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  354. scriptFile_->Execute(scriptObject_, methods_[METHOD_LOAD], parameters);
  355. }
  356. }
  357. void ScriptInstance::SetScriptNetworkDataAttr(PODVector<unsigned char> data)
  358. {
  359. if (scriptObject_ && methods_[METHOD_READNETWORKUPDATE])
  360. {
  361. MemoryBuffer buf(data);
  362. VariantVector parameters;
  363. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  364. scriptFile_->Execute(scriptObject_, methods_[METHOD_READNETWORKUPDATE], parameters);
  365. }
  366. }
  367. ResourceRef ScriptInstance::GetScriptFileAttr() const
  368. {
  369. return GetResourceRef(scriptFile_, ScriptFile::GetTypeStatic());
  370. }
  371. PODVector<unsigned char> ScriptInstance::GetDelayedCallsAttr() const
  372. {
  373. VectorBuffer buf;
  374. buf.WriteVLE(delayedCalls_.Size());
  375. for (Vector<DelayedCall>::ConstIterator i = delayedCalls_.Begin(); i != delayedCalls_.End(); ++i)
  376. {
  377. buf.WriteFloat(i->period_);
  378. buf.WriteFloat(i->delay_);
  379. buf.WriteBool(i->repeat_);
  380. buf.WriteString(i->declaration_);
  381. buf.WriteVariantVector(i->parameters_);
  382. }
  383. return buf.GetBuffer();
  384. }
  385. float ScriptInstance::GetFixedUpdateAccAttr() const
  386. {
  387. return fixedUpdateAcc_;
  388. }
  389. PODVector<unsigned char> ScriptInstance::GetScriptDataAttr() const
  390. {
  391. if (!scriptObject_ || !methods_[METHOD_SAVE])
  392. return PODVector<unsigned char>();
  393. else
  394. {
  395. VectorBuffer buf;
  396. VariantVector parameters;
  397. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  398. scriptFile_->Execute(scriptObject_, methods_[METHOD_SAVE], parameters);
  399. return buf.GetBuffer();
  400. }
  401. }
  402. PODVector<unsigned char> ScriptInstance::GetScriptNetworkDataAttr() const
  403. {
  404. if (!scriptObject_ || !methods_[METHOD_WRITENETWORKUPDATE])
  405. return PODVector<unsigned char>();
  406. else
  407. {
  408. VectorBuffer buf;
  409. VariantVector parameters;
  410. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  411. scriptFile_->Execute(scriptObject_, methods_[METHOD_WRITENETWORKUPDATE], parameters);
  412. return buf.GetBuffer();
  413. }
  414. }
  415. void ScriptInstance::OnMarkedDirty(Node* node)
  416. {
  417. // Script functions are not safe from worker threads
  418. Scene* scene = GetScene();
  419. if (scene && scene->IsThreadedUpdate())
  420. {
  421. scene->DelayedMarkedDirty(this);
  422. return;
  423. }
  424. if (scriptObject_ && methods_[METHOD_TRANSFORMCHANGED])
  425. scriptFile_->Execute(scriptObject_, methods_[METHOD_TRANSFORMCHANGED]);
  426. }
  427. void ScriptInstance::CreateObject()
  428. {
  429. if (!scriptFile_ || className_.Empty())
  430. return;
  431. PROFILE(CreateScriptObject);
  432. scriptObject_ = scriptFile_->CreateObject(className_);
  433. if (scriptObject_)
  434. {
  435. // Map script object to script instance with userdata
  436. scriptObject_->SetUserData(this);
  437. GetScriptMethods();
  438. GetScriptAttributes();
  439. UpdateEventSubscription();
  440. if (methods_[METHOD_START])
  441. scriptFile_->Execute(scriptObject_, methods_[METHOD_START]);
  442. }
  443. else
  444. LOGERROR("Failed to create object of class " + className_ + " from " + scriptFile_->GetName());
  445. }
  446. void ScriptInstance::ReleaseObject()
  447. {
  448. if (scriptObject_)
  449. {
  450. if (methods_[METHOD_STOP])
  451. scriptFile_->Execute(scriptObject_, methods_[METHOD_STOP]);
  452. PODVector<StringHash> exceptions;
  453. exceptions.Push(E_RELOADSTARTED);
  454. exceptions.Push(E_RELOADFINISHED);
  455. UnsubscribeFromAllEventsExcept(exceptions, false);
  456. if (node_)
  457. node_->RemoveListener(this);
  458. subscribed_ = false;
  459. subscribedPostFixed_ = false;
  460. ClearScriptMethods();
  461. ClearScriptAttributes();
  462. scriptObject_->SetUserData(0);
  463. scriptObject_->Release();
  464. scriptObject_ = 0;
  465. }
  466. }
  467. void ScriptInstance::ClearScriptMethods()
  468. {
  469. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  470. methods_[i] = 0;
  471. delayedCalls_.Clear();
  472. }
  473. void ScriptInstance::ClearScriptAttributes()
  474. {
  475. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  476. idAttributes_.Clear();
  477. }
  478. void ScriptInstance::GetScriptMethods()
  479. {
  480. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  481. methods_[i] = scriptFile_->GetMethod(scriptObject_, methodDeclarations[i]);
  482. }
  483. void ScriptInstance::GetScriptAttributes()
  484. {
  485. asIScriptEngine* engine = GetSubsystem<Script>()->GetScriptEngine();
  486. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  487. unsigned numProperties = scriptObject_->GetPropertyCount();
  488. for (unsigned i = 0; i < numProperties; ++i)
  489. {
  490. const char* name;
  491. int typeId;
  492. bool isPrivate, isHandle;
  493. scriptObject_->GetObjectType()->GetProperty(i, &name, &typeId, &isPrivate);
  494. // Hide private variables or ones that begin with an underscore
  495. if (isPrivate || name[0] == '_')
  496. continue;
  497. String typeName = engine->GetTypeDeclaration(typeId);
  498. isHandle = typeName.EndsWith("@");
  499. if (isHandle)
  500. typeName = typeName.Substring(0, typeName.Length() - 1);
  501. AttributeInfo info;
  502. info.mode_ = AM_FILE;
  503. info.name_ = name;
  504. info.ptr_ = scriptObject_->GetAddressOfProperty(i);
  505. if (!isHandle)
  506. {
  507. switch (typeId)
  508. {
  509. case asTYPEID_BOOL:
  510. info.type_ = VAR_BOOL;
  511. break;
  512. case asTYPEID_INT32:
  513. case asTYPEID_UINT32:
  514. info.type_ = VAR_INT;
  515. break;
  516. case asTYPEID_FLOAT:
  517. info.type_ = VAR_FLOAT;
  518. break;
  519. default:
  520. info.type_ = Variant::GetTypeFromName(typeName);
  521. break;
  522. }
  523. }
  524. else
  525. {
  526. // For a handle type, check if it's an Object subclass with a registered factory
  527. ShortStringHash typeHash(typeName);
  528. const HashMap<ShortStringHash, SharedPtr<ObjectFactory> >& factories = context_->GetObjectFactories();
  529. HashMap<ShortStringHash, SharedPtr<ObjectFactory> >::ConstIterator j = factories.Find(typeHash);
  530. if (j != factories.End())
  531. {
  532. // Check base class type. Node & Component are supported as ID attributes, Resource as a resource reference
  533. ShortStringHash baseType = j->second_->GetBaseType();
  534. if (baseType == Node::GetTypeStatic())
  535. {
  536. info.mode_ |= AM_NODEID;
  537. info.type_ = VAR_INT;
  538. }
  539. else if (baseType == Component::GetTypeStatic())
  540. {
  541. info.mode_ |= AM_COMPONENTID;
  542. info.type_ = VAR_INT;
  543. }
  544. else if (baseType == Resource::GetTypeStatic())
  545. {
  546. info.type_ = VAR_RESOURCEREF;
  547. info.defaultValue_ = ResourceRef(typeHash);
  548. }
  549. }
  550. }
  551. if (info.type_ != VAR_NONE)
  552. attributeInfos_.Push(info);
  553. }
  554. }
  555. void ScriptInstance::UpdateEventSubscription()
  556. {
  557. Scene* scene = GetScene();
  558. if (!scene)
  559. {
  560. LOGWARNING("Node is detached from scene, can not subscribe script object to update events");
  561. return;
  562. }
  563. bool enabled = scriptObject_ && IsEnabledEffective();
  564. if (enabled)
  565. {
  566. if (!subscribed_ && (methods_[METHOD_UPDATE] || methods_[METHOD_DELAYEDSTART] || delayedCalls_.Size()))
  567. {
  568. SubscribeToEvent(scene, E_SCENEUPDATE, HANDLER(ScriptInstance, HandleSceneUpdate));
  569. subscribed_ = true;
  570. }
  571. if (!subscribedPostFixed_)
  572. {
  573. if (methods_[METHOD_POSTUPDATE])
  574. SubscribeToEvent(scene, E_SCENEPOSTUPDATE, HANDLER(ScriptInstance, HandleScenePostUpdate));
  575. PhysicsWorld* world = scene->GetComponent<PhysicsWorld>();
  576. if (world)
  577. {
  578. if (methods_[METHOD_FIXEDUPDATE])
  579. SubscribeToEvent(world, E_PHYSICSPRESTEP, HANDLER(ScriptInstance, HandlePhysicsPreStep));
  580. if (methods_[METHOD_FIXEDPOSTUPDATE])
  581. SubscribeToEvent(world, E_PHYSICSPOSTSTEP, HANDLER(ScriptInstance, HandlePhysicsPostStep));
  582. }
  583. else
  584. {
  585. if (methods_[METHOD_FIXEDUPDATE] || methods_[METHOD_FIXEDPOSTUPDATE])
  586. LOGERROR("No physics world, can not subscribe script object to fixed update events");
  587. }
  588. subscribedPostFixed_ = true;
  589. }
  590. if (methods_[METHOD_TRANSFORMCHANGED])
  591. node_->AddListener(this);
  592. }
  593. else
  594. {
  595. if (subscribed_)
  596. {
  597. UnsubscribeFromEvent(scene, E_SCENEUPDATE);
  598. subscribed_ = false;
  599. }
  600. if (subscribedPostFixed_)
  601. {
  602. UnsubscribeFromEvent(scene, E_SCENEPOSTUPDATE);
  603. PhysicsWorld* world = scene->GetComponent<PhysicsWorld>();
  604. if (world)
  605. {
  606. UnsubscribeFromEvent(world, E_PHYSICSPRESTEP);
  607. UnsubscribeFromEvent(world, E_PHYSICSPOSTSTEP);
  608. }
  609. subscribedPostFixed_ = false;
  610. }
  611. if (methods_[METHOD_TRANSFORMCHANGED])
  612. node_->RemoveListener(this);
  613. }
  614. }
  615. void ScriptInstance::HandleSceneUpdate(StringHash eventType, VariantMap& eventData)
  616. {
  617. if (!scriptObject_)
  618. return;
  619. using namespace SceneUpdate;
  620. float timeStep = eventData[P_TIMESTEP].GetFloat();
  621. // Execute delayed calls
  622. for (unsigned i = 0; i < delayedCalls_.Size();)
  623. {
  624. DelayedCall& call = delayedCalls_[i];
  625. bool remove = false;
  626. call.delay_ -= timeStep;
  627. if (call.delay_ <= 0.0f)
  628. {
  629. if (!call.repeat_)
  630. remove = true;
  631. else
  632. call.delay_ += call.period_;
  633. Execute(call.declaration_, call.parameters_);
  634. }
  635. if (remove)
  636. delayedCalls_.Erase(i);
  637. else
  638. ++i;
  639. }
  640. // Execute delayed start before first update
  641. if (methods_[METHOD_DELAYEDSTART])
  642. {
  643. scriptFile_->Execute(scriptObject_, methods_[METHOD_DELAYEDSTART]);
  644. methods_[METHOD_DELAYEDSTART] = 0; // Only execute once
  645. }
  646. if (methods_[METHOD_UPDATE])
  647. {
  648. VariantVector parameters;
  649. parameters.Push(timeStep);
  650. scriptFile_->Execute(scriptObject_, methods_[METHOD_UPDATE], parameters);
  651. }
  652. }
  653. void ScriptInstance::HandleScenePostUpdate(StringHash eventType, VariantMap& eventData)
  654. {
  655. if (!scriptObject_)
  656. return;
  657. using namespace ScenePostUpdate;
  658. VariantVector parameters;
  659. parameters.Push(eventData[P_TIMESTEP]);
  660. scriptFile_->Execute(scriptObject_, methods_[METHOD_POSTUPDATE], parameters);
  661. }
  662. void ScriptInstance::HandlePhysicsPreStep(StringHash eventType, VariantMap& eventData)
  663. {
  664. if (!scriptObject_)
  665. return;
  666. using namespace PhysicsPreStep;
  667. if (!fixedUpdateFps_)
  668. {
  669. VariantVector parameters;
  670. parameters.Push(eventData[P_TIMESTEP]);
  671. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDUPDATE], parameters);
  672. }
  673. else
  674. {
  675. float timeStep = eventData[P_TIMESTEP].GetFloat();
  676. fixedUpdateAcc_ += timeStep;
  677. if (fixedUpdateAcc_ >= fixedUpdateInterval_)
  678. {
  679. fixedUpdateAcc_ = fmodf(fixedUpdateAcc_, fixedUpdateInterval_);
  680. VariantVector parameters;
  681. parameters.Push(fixedUpdateInterval_);
  682. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDUPDATE], parameters);
  683. }
  684. }
  685. }
  686. void ScriptInstance::HandlePhysicsPostStep(StringHash eventType, VariantMap& eventData)
  687. {
  688. if (!scriptObject_)
  689. return;
  690. using namespace PhysicsPostStep;
  691. if (!fixedUpdateFps_)
  692. {
  693. VariantVector parameters;
  694. parameters.Push(eventData[P_TIMESTEP]);
  695. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDPOSTUPDATE], parameters);
  696. }
  697. else
  698. {
  699. float timeStep = eventData[P_TIMESTEP].GetFloat();
  700. fixedPostUpdateAcc_ += timeStep;
  701. if (fixedPostUpdateAcc_ >= fixedUpdateInterval_)
  702. {
  703. fixedPostUpdateAcc_ = fmodf(fixedPostUpdateAcc_, fixedUpdateInterval_);
  704. VariantVector parameters;
  705. parameters.Push(fixedUpdateInterval_);
  706. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDPOSTUPDATE], parameters);
  707. }
  708. }
  709. }
  710. void ScriptInstance::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  711. {
  712. if (!IsEnabledEffective() || !scriptFile_ || !scriptObject_)
  713. return;
  714. asIScriptFunction* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  715. VariantVector parameters;
  716. if (method->GetParamCount() > 0)
  717. {
  718. parameters.Push(Variant((void*)&eventType));
  719. parameters.Push(Variant((void*)&eventData));
  720. }
  721. scriptFile_->Execute(scriptObject_, method, parameters);
  722. }
  723. void ScriptInstance::HandleScriptFileReload(StringHash eventType, VariantMap& eventData)
  724. {
  725. ReleaseObject();
  726. }
  727. void ScriptInstance::HandleScriptFileReloadFinished(StringHash eventType, VariantMap& eventData)
  728. {
  729. if (!className_.Empty())
  730. CreateObject();
  731. }
  732. Context* GetScriptContext()
  733. {
  734. return static_cast<Script*>(asGetActiveContext()->GetEngine()->GetUserData())->GetContext();
  735. }
  736. ScriptInstance* GetScriptContextInstance()
  737. {
  738. asIScriptContext* context = asGetActiveContext();
  739. asIScriptObject* object = context ? static_cast<asIScriptObject*>(context->GetThisPointer()) : 0;
  740. if (object)
  741. return static_cast<ScriptInstance*>(object->GetUserData());
  742. else
  743. return 0;
  744. }
  745. Node* GetScriptContextNode()
  746. {
  747. ScriptInstance* instance = GetScriptContextInstance();
  748. return instance ? instance->GetNode() : 0;
  749. }
  750. Scene* GetScriptContextScene()
  751. {
  752. Scene* scene = 0;
  753. Node* node = GetScriptContextNode();
  754. if (node)
  755. scene = node->GetScene();
  756. // If null, try to get the default scene
  757. if (!scene)
  758. scene = GetScriptContext()->GetSubsystem<Script>()->GetDefaultScene();
  759. return scene;
  760. }
  761. ScriptEventListener* GetScriptContextEventListener()
  762. {
  763. // If the context has an object and that object has user data set, try and get the ScriptInstance, otherwise try and get a ScriptFile.
  764. asIScriptContext* context = asGetActiveContext();
  765. if (context)
  766. {
  767. asIScriptObject* object = static_cast<asIScriptObject*>(context->GetThisPointer());
  768. if (object && object->GetUserData())
  769. return GetScriptContextInstance();
  770. else
  771. return GetScriptContextFile();
  772. }
  773. else
  774. return 0;
  775. }
  776. Object* GetScriptContextEventListenerObject()
  777. {
  778. return dynamic_cast<Object*>(GetScriptContextEventListener());
  779. }
  780. }